@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
@@ -26,6 +26,26 @@ export interface AddCustomAttributesCommandOutput extends AddCustomAttributesRes
26
26
  * import { CognitoIdentityProviderClient, AddCustomAttributesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, AddCustomAttributesCommand } = 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
+ * CustomAttributes: [ // required
32
+ * {
33
+ * Name: "STRING_VALUE",
34
+ * AttributeDataType: "String" || "Number" || "DateTime" || "Boolean",
35
+ * DeveloperOnlyAttribute: true || false,
36
+ * Mutable: true || false,
37
+ * Required: true || false,
38
+ * NumberAttributeConstraints: {
39
+ * MinValue: "STRING_VALUE",
40
+ * MaxValue: "STRING_VALUE",
41
+ * },
42
+ * StringAttributeConstraints: {
43
+ * MinLength: "STRING_VALUE",
44
+ * MaxLength: "STRING_VALUE",
45
+ * },
46
+ * },
47
+ * ],
48
+ * };
29
49
  * const command = new AddCustomAttributesCommand(input);
30
50
  * const response = await client.send(command);
31
51
  * ```
@@ -27,6 +27,11 @@ export interface AdminAddUserToGroupCommandOutput extends __MetadataBearer {
27
27
  * import { CognitoIdentityProviderClient, AdminAddUserToGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, AdminAddUserToGroupCommand } = 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
+ * Username: "STRING_VALUE", // required
33
+ * GroupName: "STRING_VALUE", // required
34
+ * };
30
35
  * const command = new AdminAddUserToGroupCommand(input);
31
36
  * const response = await client.send(command);
32
37
  * ```
@@ -28,6 +28,13 @@ export interface AdminConfirmSignUpCommandOutput extends AdminConfirmSignUpRespo
28
28
  * import { CognitoIdentityProviderClient, AdminConfirmSignUpCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
29
29
  * // const { CognitoIdentityProviderClient, AdminConfirmSignUpCommand } = 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
+ * Username: "STRING_VALUE", // required
34
+ * ClientMetadata: {
35
+ * "<keys>": "STRING_VALUE",
36
+ * },
37
+ * };
31
38
  * const command = new AdminConfirmSignUpCommand(input);
32
39
  * const response = await client.send(command);
33
40
  * ```
@@ -56,6 +56,31 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
56
56
  * import { CognitoIdentityProviderClient, AdminCreateUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
57
57
  * // const { CognitoIdentityProviderClient, AdminCreateUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
58
58
  * const client = new CognitoIdentityProviderClient(config);
59
+ * const input = {
60
+ * UserPoolId: "STRING_VALUE", // required
61
+ * Username: "STRING_VALUE", // required
62
+ * UserAttributes: [
63
+ * {
64
+ * Name: "STRING_VALUE", // required
65
+ * Value: "STRING_VALUE",
66
+ * },
67
+ * ],
68
+ * ValidationData: [
69
+ * {
70
+ * Name: "STRING_VALUE", // required
71
+ * Value: "STRING_VALUE",
72
+ * },
73
+ * ],
74
+ * TemporaryPassword: "STRING_VALUE",
75
+ * ForceAliasCreation: true || false,
76
+ * MessageAction: "RESEND" || "SUPPRESS",
77
+ * DesiredDeliveryMediums: [
78
+ * "SMS" || "EMAIL",
79
+ * ],
80
+ * ClientMetadata: {
81
+ * "<keys>": "STRING_VALUE",
82
+ * },
83
+ * };
59
84
  * const command = new AdminCreateUserCommand(input);
60
85
  * const response = await client.send(command);
61
86
  * ```
@@ -28,6 +28,13 @@ export interface AdminDeleteUserAttributesCommandOutput extends AdminDeleteUserA
28
28
  * import { CognitoIdentityProviderClient, AdminDeleteUserAttributesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
29
29
  * // const { CognitoIdentityProviderClient, AdminDeleteUserAttributesCommand } = 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
+ * Username: "STRING_VALUE", // required
34
+ * UserAttributeNames: [ // required
35
+ * "STRING_VALUE",
36
+ * ],
37
+ * };
31
38
  * const command = new AdminDeleteUserAttributesCommand(input);
32
39
  * const response = await client.send(command);
33
40
  * ```
@@ -27,6 +27,10 @@ export interface AdminDeleteUserCommandOutput extends __MetadataBearer {
27
27
  * import { CognitoIdentityProviderClient, AdminDeleteUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, AdminDeleteUserCommand } = 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
+ * Username: "STRING_VALUE", // required
33
+ * };
30
34
  * const command = new AdminDeleteUserCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -53,6 +53,14 @@ export interface AdminDisableProviderForUserCommandOutput extends AdminDisablePr
53
53
  * import { CognitoIdentityProviderClient, AdminDisableProviderForUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
54
54
  * // const { CognitoIdentityProviderClient, AdminDisableProviderForUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
55
55
  * const client = new CognitoIdentityProviderClient(config);
56
+ * const input = {
57
+ * UserPoolId: "STRING_VALUE", // required
58
+ * User: {
59
+ * ProviderName: "STRING_VALUE",
60
+ * ProviderAttributeName: "STRING_VALUE",
61
+ * ProviderAttributeValue: "STRING_VALUE",
62
+ * },
63
+ * };
56
64
  * const command = new AdminDisableProviderForUserCommand(input);
57
65
  * const response = await client.send(command);
58
66
  * ```
@@ -28,6 +28,10 @@ export interface AdminDisableUserCommandOutput extends AdminDisableUserResponse,
28
28
  * import { CognitoIdentityProviderClient, AdminDisableUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
29
29
  * // const { CognitoIdentityProviderClient, AdminDisableUserCommand } = 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
+ * Username: "STRING_VALUE", // required
34
+ * };
31
35
  * const command = new AdminDisableUserCommand(input);
32
36
  * const response = await client.send(command);
33
37
  * ```
@@ -27,6 +27,10 @@ export interface AdminEnableUserCommandOutput extends AdminEnableUserResponse, _
27
27
  * import { CognitoIdentityProviderClient, AdminEnableUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, AdminEnableUserCommand } = 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
+ * Username: "STRING_VALUE", // required
33
+ * };
30
34
  * const command = new AdminEnableUserCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -27,6 +27,11 @@ export interface AdminForgetDeviceCommandOutput extends __MetadataBearer {
27
27
  * import { CognitoIdentityProviderClient, AdminForgetDeviceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, AdminForgetDeviceCommand } = 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
+ * Username: "STRING_VALUE", // required
33
+ * DeviceKey: "STRING_VALUE", // required
34
+ * };
30
35
  * const command = new AdminForgetDeviceCommand(input);
31
36
  * const response = await client.send(command);
32
37
  * ```
@@ -27,6 +27,11 @@ export interface AdminGetDeviceCommandOutput extends AdminGetDeviceResponse, __M
27
27
  * import { CognitoIdentityProviderClient, AdminGetDeviceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, AdminGetDeviceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
29
29
  * const client = new CognitoIdentityProviderClient(config);
30
+ * const input = {
31
+ * DeviceKey: "STRING_VALUE", // required
32
+ * UserPoolId: "STRING_VALUE", // required
33
+ * Username: "STRING_VALUE", // required
34
+ * };
30
35
  * const command = new AdminGetDeviceCommand(input);
31
36
  * const response = await client.send(command);
32
37
  * ```
@@ -28,6 +28,10 @@ export interface AdminGetUserCommandOutput extends AdminGetUserResponse, __Metad
28
28
  * import { CognitoIdentityProviderClient, AdminGetUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
29
29
  * // const { CognitoIdentityProviderClient, AdminGetUserCommand } = 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
+ * Username: "STRING_VALUE", // required
34
+ * };
31
35
  * const command = new AdminGetUserCommand(input);
32
36
  * const response = await client.send(command);
33
37
  * ```
@@ -46,6 +46,32 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
46
46
  * import { CognitoIdentityProviderClient, AdminInitiateAuthCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
47
47
  * // const { CognitoIdentityProviderClient, AdminInitiateAuthCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
48
48
  * const client = new CognitoIdentityProviderClient(config);
49
+ * const input = {
50
+ * UserPoolId: "STRING_VALUE", // required
51
+ * ClientId: "STRING_VALUE", // required
52
+ * AuthFlow: "USER_SRP_AUTH" || "REFRESH_TOKEN_AUTH" || "REFRESH_TOKEN" || "CUSTOM_AUTH" || "ADMIN_NO_SRP_AUTH" || "USER_PASSWORD_AUTH" || "ADMIN_USER_PASSWORD_AUTH", // required
53
+ * AuthParameters: {
54
+ * "<keys>": "STRING_VALUE",
55
+ * },
56
+ * ClientMetadata: {
57
+ * "<keys>": "STRING_VALUE",
58
+ * },
59
+ * AnalyticsMetadata: {
60
+ * AnalyticsEndpointId: "STRING_VALUE",
61
+ * },
62
+ * ContextData: {
63
+ * IpAddress: "STRING_VALUE", // required
64
+ * ServerName: "STRING_VALUE", // required
65
+ * ServerPath: "STRING_VALUE", // required
66
+ * HttpHeaders: [ // required
67
+ * {
68
+ * headerName: "STRING_VALUE",
69
+ * headerValue: "STRING_VALUE",
70
+ * },
71
+ * ],
72
+ * EncodedData: "STRING_VALUE",
73
+ * },
74
+ * };
49
75
  * const command = new AdminInitiateAuthCommand(input);
50
76
  * const response = await client.send(command);
51
77
  * ```
@@ -44,6 +44,19 @@ export interface AdminLinkProviderForUserCommandOutput extends AdminLinkProvider
44
44
  * import { CognitoIdentityProviderClient, AdminLinkProviderForUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
45
45
  * // const { CognitoIdentityProviderClient, AdminLinkProviderForUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
46
46
  * const client = new CognitoIdentityProviderClient(config);
47
+ * const input = {
48
+ * UserPoolId: "STRING_VALUE", // required
49
+ * DestinationUser: {
50
+ * ProviderName: "STRING_VALUE",
51
+ * ProviderAttributeName: "STRING_VALUE",
52
+ * ProviderAttributeValue: "STRING_VALUE",
53
+ * },
54
+ * SourceUser: {
55
+ * ProviderName: "STRING_VALUE",
56
+ * ProviderAttributeName: "STRING_VALUE",
57
+ * ProviderAttributeValue: "STRING_VALUE",
58
+ * },
59
+ * };
47
60
  * const command = new AdminLinkProviderForUserCommand(input);
48
61
  * const response = await client.send(command);
49
62
  * ```
@@ -27,6 +27,12 @@ export interface AdminListDevicesCommandOutput extends AdminListDevicesResponse,
27
27
  * import { CognitoIdentityProviderClient, AdminListDevicesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, AdminListDevicesCommand } = 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
+ * Username: "STRING_VALUE", // required
33
+ * Limit: Number("int"),
34
+ * PaginationToken: "STRING_VALUE",
35
+ * };
30
36
  * const command = new AdminListDevicesCommand(input);
31
37
  * const response = await client.send(command);
32
38
  * ```
@@ -27,6 +27,12 @@ export interface AdminListGroupsForUserCommandOutput extends AdminListGroupsForU
27
27
  * import { CognitoIdentityProviderClient, AdminListGroupsForUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, AdminListGroupsForUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
29
29
  * const client = new CognitoIdentityProviderClient(config);
30
+ * const input = {
31
+ * Username: "STRING_VALUE", // required
32
+ * UserPoolId: "STRING_VALUE", // required
33
+ * Limit: Number("int"),
34
+ * NextToken: "STRING_VALUE",
35
+ * };
30
36
  * const command = new AdminListGroupsForUserCommand(input);
31
37
  * const response = await client.send(command);
32
38
  * ```
@@ -27,6 +27,12 @@ export interface AdminListUserAuthEventsCommandOutput extends AdminListUserAuthE
27
27
  * import { CognitoIdentityProviderClient, AdminListUserAuthEventsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, AdminListUserAuthEventsCommand } = 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
+ * Username: "STRING_VALUE", // required
33
+ * MaxResults: Number("int"),
34
+ * NextToken: "STRING_VALUE",
35
+ * };
30
36
  * const command = new AdminListUserAuthEventsCommand(input);
31
37
  * const response = await client.send(command);
32
38
  * ```
@@ -27,6 +27,11 @@ export interface AdminRemoveUserFromGroupCommandOutput extends __MetadataBearer
27
27
  * import { CognitoIdentityProviderClient, AdminRemoveUserFromGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, AdminRemoveUserFromGroupCommand } = 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
+ * Username: "STRING_VALUE", // required
33
+ * GroupName: "STRING_VALUE", // required
34
+ * };
30
35
  * const command = new AdminRemoveUserFromGroupCommand(input);
31
36
  * const response = await client.send(command);
32
37
  * ```
@@ -55,6 +55,13 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
55
55
  * import { CognitoIdentityProviderClient, AdminResetUserPasswordCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
56
56
  * // const { CognitoIdentityProviderClient, AdminResetUserPasswordCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
57
57
  * const client = new CognitoIdentityProviderClient(config);
58
+ * const input = {
59
+ * UserPoolId: "STRING_VALUE", // required
60
+ * Username: "STRING_VALUE", // required
61
+ * ClientMetadata: {
62
+ * "<keys>": "STRING_VALUE",
63
+ * },
64
+ * };
58
65
  * const command = new AdminResetUserPasswordCommand(input);
59
66
  * const response = await client.send(command);
60
67
  * ```
@@ -46,6 +46,33 @@ export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondTo
46
46
  * import { CognitoIdentityProviderClient, AdminRespondToAuthChallengeCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
47
47
  * // const { CognitoIdentityProviderClient, AdminRespondToAuthChallengeCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
48
48
  * const client = new CognitoIdentityProviderClient(config);
49
+ * const input = {
50
+ * UserPoolId: "STRING_VALUE", // required
51
+ * ClientId: "STRING_VALUE", // required
52
+ * ChallengeName: "SMS_MFA" || "SOFTWARE_TOKEN_MFA" || "SELECT_MFA_TYPE" || "MFA_SETUP" || "PASSWORD_VERIFIER" || "CUSTOM_CHALLENGE" || "DEVICE_SRP_AUTH" || "DEVICE_PASSWORD_VERIFIER" || "ADMIN_NO_SRP_AUTH" || "NEW_PASSWORD_REQUIRED", // required
53
+ * ChallengeResponses: {
54
+ * "<keys>": "STRING_VALUE",
55
+ * },
56
+ * Session: "STRING_VALUE",
57
+ * AnalyticsMetadata: {
58
+ * AnalyticsEndpointId: "STRING_VALUE",
59
+ * },
60
+ * ContextData: {
61
+ * IpAddress: "STRING_VALUE", // required
62
+ * ServerName: "STRING_VALUE", // required
63
+ * ServerPath: "STRING_VALUE", // required
64
+ * HttpHeaders: [ // required
65
+ * {
66
+ * headerName: "STRING_VALUE",
67
+ * headerValue: "STRING_VALUE",
68
+ * },
69
+ * ],
70
+ * EncodedData: "STRING_VALUE",
71
+ * },
72
+ * ClientMetadata: {
73
+ * "<keys>": "STRING_VALUE",
74
+ * },
75
+ * };
49
76
  * const command = new AdminRespondToAuthChallengeCommand(input);
50
77
  * const response = await client.send(command);
51
78
  * ```
@@ -30,6 +30,18 @@ export interface AdminSetUserMFAPreferenceCommandOutput extends AdminSetUserMFAP
30
30
  * import { CognitoIdentityProviderClient, AdminSetUserMFAPreferenceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
31
31
  * // const { CognitoIdentityProviderClient, AdminSetUserMFAPreferenceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
32
32
  * const client = new CognitoIdentityProviderClient(config);
33
+ * const input = {
34
+ * SMSMfaSettings: {
35
+ * Enabled: true || false,
36
+ * PreferredMfa: true || false,
37
+ * },
38
+ * SoftwareTokenMfaSettings: {
39
+ * Enabled: true || false,
40
+ * PreferredMfa: true || false,
41
+ * },
42
+ * Username: "STRING_VALUE", // required
43
+ * UserPoolId: "STRING_VALUE", // required
44
+ * };
33
45
  * const command = new AdminSetUserMFAPreferenceCommand(input);
34
46
  * const response = await client.send(command);
35
47
  * ```
@@ -35,6 +35,12 @@ export interface AdminSetUserPasswordCommandOutput extends AdminSetUserPasswordR
35
35
  * import { CognitoIdentityProviderClient, AdminSetUserPasswordCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
36
36
  * // const { CognitoIdentityProviderClient, AdminSetUserPasswordCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
37
37
  * const client = new CognitoIdentityProviderClient(config);
38
+ * const input = {
39
+ * UserPoolId: "STRING_VALUE", // required
40
+ * Username: "STRING_VALUE", // required
41
+ * Password: "STRING_VALUE", // required
42
+ * Permanent: true || false,
43
+ * };
38
44
  * const command = new AdminSetUserPasswordCommand(input);
39
45
  * const response = await client.send(command);
40
46
  * ```
@@ -29,6 +29,16 @@ export interface AdminSetUserSettingsCommandOutput extends AdminSetUserSettingsR
29
29
  * import { CognitoIdentityProviderClient, AdminSetUserSettingsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
30
30
  * // const { CognitoIdentityProviderClient, AdminSetUserSettingsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
31
31
  * const client = new CognitoIdentityProviderClient(config);
32
+ * const input = {
33
+ * UserPoolId: "STRING_VALUE", // required
34
+ * Username: "STRING_VALUE", // required
35
+ * MFAOptions: [ // required
36
+ * {
37
+ * DeliveryMedium: "SMS" || "EMAIL",
38
+ * AttributeName: "STRING_VALUE",
39
+ * },
40
+ * ],
41
+ * };
32
42
  * const command = new AdminSetUserSettingsCommand(input);
33
43
  * const response = await client.send(command);
34
44
  * ```
@@ -28,6 +28,12 @@ export interface AdminUpdateAuthEventFeedbackCommandOutput extends AdminUpdateAu
28
28
  * import { CognitoIdentityProviderClient, AdminUpdateAuthEventFeedbackCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
29
29
  * // const { CognitoIdentityProviderClient, AdminUpdateAuthEventFeedbackCommand } = 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
+ * Username: "STRING_VALUE", // required
34
+ * EventId: "STRING_VALUE", // required
35
+ * FeedbackValue: "Valid" || "Invalid", // required
36
+ * };
31
37
  * const command = new AdminUpdateAuthEventFeedbackCommand(input);
32
38
  * const response = await client.send(command);
33
39
  * ```
@@ -27,6 +27,12 @@ export interface AdminUpdateDeviceStatusCommandOutput extends AdminUpdateDeviceS
27
27
  * import { CognitoIdentityProviderClient, AdminUpdateDeviceStatusCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, AdminUpdateDeviceStatusCommand } = 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
+ * Username: "STRING_VALUE", // required
33
+ * DeviceKey: "STRING_VALUE", // required
34
+ * DeviceRememberedStatus: "remembered" || "not_remembered",
35
+ * };
30
36
  * const command = new AdminUpdateDeviceStatusCommand(input);
31
37
  * const response = await client.send(command);
32
38
  * ```
@@ -51,6 +51,19 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA
51
51
  * import { CognitoIdentityProviderClient, AdminUpdateUserAttributesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
52
52
  * // const { CognitoIdentityProviderClient, AdminUpdateUserAttributesCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
53
53
  * const client = new CognitoIdentityProviderClient(config);
54
+ * const input = {
55
+ * UserPoolId: "STRING_VALUE", // required
56
+ * Username: "STRING_VALUE", // required
57
+ * UserAttributes: [ // required
58
+ * {
59
+ * Name: "STRING_VALUE", // required
60
+ * Value: "STRING_VALUE",
61
+ * },
62
+ * ],
63
+ * ClientMetadata: {
64
+ * "<keys>": "STRING_VALUE",
65
+ * },
66
+ * };
54
67
  * const command = new AdminUpdateUserAttributesCommand(input);
55
68
  * const response = await client.send(command);
56
69
  * ```
@@ -32,6 +32,10 @@ export interface AdminUserGlobalSignOutCommandOutput extends AdminUserGlobalSign
32
32
  * import { CognitoIdentityProviderClient, AdminUserGlobalSignOutCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
33
33
  * // const { CognitoIdentityProviderClient, AdminUserGlobalSignOutCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
34
34
  * const client = new CognitoIdentityProviderClient(config);
35
+ * const input = {
36
+ * UserPoolId: "STRING_VALUE", // required
37
+ * Username: "STRING_VALUE", // required
38
+ * };
35
39
  * const command = new AdminUserGlobalSignOutCommand(input);
36
40
  * const response = await client.send(command);
37
41
  * ```
@@ -42,6 +42,10 @@ export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTo
42
42
  * import { CognitoIdentityProviderClient, AssociateSoftwareTokenCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
43
43
  * // const { CognitoIdentityProviderClient, AssociateSoftwareTokenCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
44
44
  * const client = new CognitoIdentityProviderClient(config);
45
+ * const input = {
46
+ * AccessToken: "STRING_VALUE",
47
+ * Session: "STRING_VALUE",
48
+ * };
45
49
  * const command = new AssociateSoftwareTokenCommand(input);
46
50
  * const response = await client.send(command);
47
51
  * ```
@@ -26,6 +26,11 @@ export interface ChangePasswordCommandOutput extends ChangePasswordResponse, __M
26
26
  * import { CognitoIdentityProviderClient, ChangePasswordCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, ChangePasswordCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * PreviousPassword: "STRING_VALUE", // required
31
+ * ProposedPassword: "STRING_VALUE", // required
32
+ * AccessToken: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new ChangePasswordCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -27,6 +27,15 @@ export interface ConfirmDeviceCommandOutput extends ConfirmDeviceResponse, __Met
27
27
  * import { CognitoIdentityProviderClient, ConfirmDeviceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, ConfirmDeviceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
29
29
  * const client = new CognitoIdentityProviderClient(config);
30
+ * const input = {
31
+ * AccessToken: "STRING_VALUE", // required
32
+ * DeviceKey: "STRING_VALUE", // required
33
+ * DeviceSecretVerifierConfig: {
34
+ * PasswordVerifier: "STRING_VALUE",
35
+ * Salt: "STRING_VALUE",
36
+ * },
37
+ * DeviceName: "STRING_VALUE",
38
+ * };
30
39
  * const command = new ConfirmDeviceCommand(input);
31
40
  * const response = await client.send(command);
32
41
  * ```
@@ -26,6 +26,23 @@ export interface ConfirmForgotPasswordCommandOutput extends ConfirmForgotPasswor
26
26
  * import { CognitoIdentityProviderClient, ConfirmForgotPasswordCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, ConfirmForgotPasswordCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * ClientId: "STRING_VALUE", // required
31
+ * SecretHash: "STRING_VALUE",
32
+ * Username: "STRING_VALUE", // required
33
+ * ConfirmationCode: "STRING_VALUE", // required
34
+ * Password: "STRING_VALUE", // required
35
+ * AnalyticsMetadata: {
36
+ * AnalyticsEndpointId: "STRING_VALUE",
37
+ * },
38
+ * UserContextData: {
39
+ * IpAddress: "STRING_VALUE",
40
+ * EncodedData: "STRING_VALUE",
41
+ * },
42
+ * ClientMetadata: {
43
+ * "<keys>": "STRING_VALUE",
44
+ * },
45
+ * };
29
46
  * const command = new ConfirmForgotPasswordCommand(input);
30
47
  * const response = await client.send(command);
31
48
  * ```
@@ -26,6 +26,23 @@ export interface ConfirmSignUpCommandOutput extends ConfirmSignUpResponse, __Met
26
26
  * import { CognitoIdentityProviderClient, ConfirmSignUpCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, ConfirmSignUpCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * ClientId: "STRING_VALUE", // required
31
+ * SecretHash: "STRING_VALUE",
32
+ * Username: "STRING_VALUE", // required
33
+ * ConfirmationCode: "STRING_VALUE", // required
34
+ * ForceAliasCreation: true || false,
35
+ * AnalyticsMetadata: {
36
+ * AnalyticsEndpointId: "STRING_VALUE",
37
+ * },
38
+ * UserContextData: {
39
+ * IpAddress: "STRING_VALUE",
40
+ * EncodedData: "STRING_VALUE",
41
+ * },
42
+ * ClientMetadata: {
43
+ * "<keys>": "STRING_VALUE",
44
+ * },
45
+ * };
29
46
  * const command = new ConfirmSignUpCommand(input);
30
47
  * const response = await client.send(command);
31
48
  * ```
@@ -27,6 +27,13 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
27
27
  * import { CognitoIdentityProviderClient, CreateGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, CreateGroupCommand } = 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
+ * Description: "STRING_VALUE",
34
+ * RoleArn: "STRING_VALUE",
35
+ * Precedence: Number("int"),
36
+ * };
30
37
  * const command = new CreateGroupCommand(input);
31
38
  * const response = await client.send(command);
32
39
  * ```
@@ -26,6 +26,20 @@ export interface CreateIdentityProviderCommandOutput extends CreateIdentityProvi
26
26
  * import { CognitoIdentityProviderClient, CreateIdentityProviderCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, CreateIdentityProviderCommand } = 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
+ * ProviderType: "SAML" || "Facebook" || "Google" || "LoginWithAmazon" || "SignInWithApple" || "OIDC", // required
33
+ * ProviderDetails: { // required
34
+ * "<keys>": "STRING_VALUE",
35
+ * },
36
+ * AttributeMapping: {
37
+ * "<keys>": "STRING_VALUE",
38
+ * },
39
+ * IdpIdentifiers: [
40
+ * "STRING_VALUE",
41
+ * ],
42
+ * };
29
43
  * const command = new CreateIdentityProviderCommand(input);
30
44
  * const response = await client.send(command);
31
45
  * ```
@@ -26,6 +26,17 @@ export interface CreateResourceServerCommandOutput extends CreateResourceServerR
26
26
  * import { CognitoIdentityProviderClient, CreateResourceServerCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, CreateResourceServerCommand } = 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
+ * Name: "STRING_VALUE", // required
33
+ * Scopes: [
34
+ * {
35
+ * ScopeName: "STRING_VALUE", // required
36
+ * ScopeDescription: "STRING_VALUE", // required
37
+ * },
38
+ * ],
39
+ * };
29
40
  * const command = new CreateResourceServerCommand(input);
30
41
  * const response = await client.send(command);
31
42
  * ```
@@ -26,6 +26,11 @@ export interface CreateUserImportJobCommandOutput extends CreateUserImportJobRes
26
26
  * import { CognitoIdentityProviderClient, CreateUserImportJobCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, CreateUserImportJobCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * JobName: "STRING_VALUE", // required
31
+ * UserPoolId: "STRING_VALUE", // required
32
+ * CloudWatchLogsRoleArn: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new CreateUserImportJobCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```