@aws-sdk/client-cognito-identity-provider 3.299.0 → 3.301.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
@@ -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 = { // ListTagsForResourceRequest
33
+ * ResourceArn: "STRING_VALUE", // required
34
+ * };
32
35
  * const command = new ListTagsForResourceCommand(input);
33
36
  * const response = await client.send(command);
34
37
  * ```
@@ -26,6 +26,11 @@ export interface ListUserImportJobsCommandOutput extends ListUserImportJobsRespo
26
26
  * import { CognitoIdentityProviderClient, ListUserImportJobsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, ListUserImportJobsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = { // ListUserImportJobsRequest
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * MaxResults: Number("int"), // required
32
+ * PaginationToken: "STRING_VALUE",
33
+ * };
29
34
  * const command = new ListUserImportJobsCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,11 @@ export interface ListUserPoolClientsCommandOutput extends ListUserPoolClientsRes
26
26
  * import { CognitoIdentityProviderClient, ListUserPoolClientsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, ListUserPoolClientsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = { // ListUserPoolClientsRequest
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * MaxResults: Number("int"),
32
+ * NextToken: "STRING_VALUE",
33
+ * };
29
34
  * const command = new ListUserPoolClientsCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,10 @@ export interface ListUserPoolsCommandOutput extends ListUserPoolsResponse, __Met
26
26
  * import { CognitoIdentityProviderClient, ListUserPoolsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, ListUserPoolsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = { // ListUserPoolsRequest
30
+ * NextToken: "STRING_VALUE",
31
+ * MaxResults: Number("int"), // required
32
+ * };
29
33
  * const command = new ListUserPoolsCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,15 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
26
26
  * import { CognitoIdentityProviderClient, ListUsersCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, ListUsersCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = { // ListUsersRequest
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * AttributesToGet: [ // SearchedAttributeNamesListType
32
+ * "STRING_VALUE",
33
+ * ],
34
+ * Limit: Number("int"),
35
+ * PaginationToken: "STRING_VALUE",
36
+ * Filter: "STRING_VALUE",
37
+ * };
29
38
  * const command = new ListUsersCommand(input);
30
39
  * const response = await client.send(command);
31
40
  * ```
@@ -27,6 +27,12 @@ export interface ListUsersInGroupCommandOutput extends ListUsersInGroupResponse,
27
27
  * import { CognitoIdentityProviderClient, ListUsersInGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, ListUsersInGroupCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
29
29
  * const client = new CognitoIdentityProviderClient(config);
30
+ * const input = { // ListUsersInGroupRequest
31
+ * UserPoolId: "STRING_VALUE", // required
32
+ * GroupName: "STRING_VALUE", // required
33
+ * Limit: Number("int"),
34
+ * NextToken: "STRING_VALUE",
35
+ * };
30
36
  * const command = new ListUsersInGroupCommand(input);
31
37
  * const response = await client.send(command);
32
38
  * ```
@@ -45,6 +45,21 @@ export interface ResendConfirmationCodeCommandOutput extends ResendConfirmationC
45
45
  * import { CognitoIdentityProviderClient, ResendConfirmationCodeCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
46
46
  * // const { CognitoIdentityProviderClient, ResendConfirmationCodeCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
47
47
  * const client = new CognitoIdentityProviderClient(config);
48
+ * const input = { // ResendConfirmationCodeRequest
49
+ * ClientId: "STRING_VALUE", // required
50
+ * SecretHash: "STRING_VALUE",
51
+ * UserContextData: { // UserContextDataType
52
+ * IpAddress: "STRING_VALUE",
53
+ * EncodedData: "STRING_VALUE",
54
+ * },
55
+ * Username: "STRING_VALUE", // required
56
+ * AnalyticsMetadata: { // AnalyticsMetadataType
57
+ * AnalyticsEndpointId: "STRING_VALUE",
58
+ * },
59
+ * ClientMetadata: { // ClientMetadataType
60
+ * "<keys>": "STRING_VALUE",
61
+ * },
62
+ * };
48
63
  * const command = new ResendConfirmationCodeCommand(input);
49
64
  * const response = await client.send(command);
50
65
  * ```
@@ -44,6 +44,24 @@ export interface RespondToAuthChallengeCommandOutput extends RespondToAuthChalle
44
44
  * import { CognitoIdentityProviderClient, RespondToAuthChallengeCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
45
45
  * // const { CognitoIdentityProviderClient, RespondToAuthChallengeCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
46
46
  * const client = new CognitoIdentityProviderClient(config);
47
+ * const input = { // RespondToAuthChallengeRequest
48
+ * ClientId: "STRING_VALUE", // required
49
+ * 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
50
+ * Session: "STRING_VALUE",
51
+ * ChallengeResponses: { // ChallengeResponsesType
52
+ * "<keys>": "STRING_VALUE",
53
+ * },
54
+ * AnalyticsMetadata: { // AnalyticsMetadataType
55
+ * AnalyticsEndpointId: "STRING_VALUE",
56
+ * },
57
+ * UserContextData: { // UserContextDataType
58
+ * IpAddress: "STRING_VALUE",
59
+ * EncodedData: "STRING_VALUE",
60
+ * },
61
+ * ClientMetadata: { // ClientMetadataType
62
+ * "<keys>": "STRING_VALUE",
63
+ * },
64
+ * };
47
65
  * const command = new RespondToAuthChallengeCommand(input);
48
66
  * const response = await client.send(command);
49
67
  * ```
@@ -28,6 +28,11 @@ export interface RevokeTokenCommandOutput extends RevokeTokenResponse, __Metadat
28
28
  * import { CognitoIdentityProviderClient, RevokeTokenCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
29
29
  * // const { CognitoIdentityProviderClient, RevokeTokenCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
30
30
  * const client = new CognitoIdentityProviderClient(config);
31
+ * const input = { // RevokeTokenRequest
32
+ * Token: "STRING_VALUE", // required
33
+ * ClientId: "STRING_VALUE", // required
34
+ * ClientSecret: "STRING_VALUE",
35
+ * };
31
36
  * const command = new RevokeTokenCommand(input);
32
37
  * const response = await client.send(command);
33
38
  * ```
@@ -30,6 +30,62 @@ export interface SetRiskConfigurationCommandOutput extends SetRiskConfigurationR
30
30
  * import { CognitoIdentityProviderClient, SetRiskConfigurationCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
31
31
  * // const { CognitoIdentityProviderClient, SetRiskConfigurationCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
32
32
  * const client = new CognitoIdentityProviderClient(config);
33
+ * const input = { // SetRiskConfigurationRequest
34
+ * UserPoolId: "STRING_VALUE", // required
35
+ * ClientId: "STRING_VALUE",
36
+ * CompromisedCredentialsRiskConfiguration: { // CompromisedCredentialsRiskConfigurationType
37
+ * EventFilter: [ // EventFiltersType
38
+ * "SIGN_IN" || "PASSWORD_CHANGE" || "SIGN_UP",
39
+ * ],
40
+ * Actions: { // CompromisedCredentialsActionsType
41
+ * EventAction: "BLOCK" || "NO_ACTION", // required
42
+ * },
43
+ * },
44
+ * AccountTakeoverRiskConfiguration: { // AccountTakeoverRiskConfigurationType
45
+ * NotifyConfiguration: { // NotifyConfigurationType
46
+ * From: "STRING_VALUE",
47
+ * ReplyTo: "STRING_VALUE",
48
+ * SourceArn: "STRING_VALUE", // required
49
+ * BlockEmail: { // NotifyEmailType
50
+ * Subject: "STRING_VALUE", // required
51
+ * HtmlBody: "STRING_VALUE",
52
+ * TextBody: "STRING_VALUE",
53
+ * },
54
+ * NoActionEmail: {
55
+ * Subject: "STRING_VALUE", // required
56
+ * HtmlBody: "STRING_VALUE",
57
+ * TextBody: "STRING_VALUE",
58
+ * },
59
+ * MfaEmail: {
60
+ * Subject: "STRING_VALUE", // required
61
+ * HtmlBody: "STRING_VALUE",
62
+ * TextBody: "STRING_VALUE",
63
+ * },
64
+ * },
65
+ * Actions: { // AccountTakeoverActionsType
66
+ * LowAction: { // AccountTakeoverActionType
67
+ * Notify: true || false, // required
68
+ * EventAction: "BLOCK" || "MFA_IF_CONFIGURED" || "MFA_REQUIRED" || "NO_ACTION", // required
69
+ * },
70
+ * MediumAction: {
71
+ * Notify: true || false, // required
72
+ * EventAction: "BLOCK" || "MFA_IF_CONFIGURED" || "MFA_REQUIRED" || "NO_ACTION", // required
73
+ * },
74
+ * HighAction: {
75
+ * Notify: true || false, // required
76
+ * EventAction: "BLOCK" || "MFA_IF_CONFIGURED" || "MFA_REQUIRED" || "NO_ACTION", // required
77
+ * },
78
+ * },
79
+ * },
80
+ * RiskExceptionConfiguration: { // RiskExceptionConfigurationType
81
+ * BlockedIPRangeList: [ // BlockedIPRangeListType
82
+ * "STRING_VALUE",
83
+ * ],
84
+ * SkippedIPRangeList: [ // SkippedIPRangeListType
85
+ * "STRING_VALUE",
86
+ * ],
87
+ * },
88
+ * };
33
89
  * const command = new SetRiskConfigurationCommand(input);
34
90
  * const response = await client.send(command);
35
91
  * ```
@@ -38,6 +38,12 @@ export interface SetUICustomizationCommandOutput extends SetUICustomizationRespo
38
38
  * import { CognitoIdentityProviderClient, SetUICustomizationCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
39
39
  * // const { CognitoIdentityProviderClient, SetUICustomizationCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
40
40
  * const client = new CognitoIdentityProviderClient(config);
41
+ * const input = { // SetUICustomizationRequest
42
+ * UserPoolId: "STRING_VALUE", // required
43
+ * ClientId: "STRING_VALUE",
44
+ * CSS: "STRING_VALUE",
45
+ * ImageFile: "BLOB_VALUE",
46
+ * };
41
47
  * const command = new SetUICustomizationCommand(input);
42
48
  * const response = await client.send(command);
43
49
  * ```
@@ -34,6 +34,17 @@ export interface SetUserMFAPreferenceCommandOutput extends SetUserMFAPreferenceR
34
34
  * import { CognitoIdentityProviderClient, SetUserMFAPreferenceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
35
35
  * // const { CognitoIdentityProviderClient, SetUserMFAPreferenceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
36
36
  * const client = new CognitoIdentityProviderClient(config);
37
+ * const input = { // SetUserMFAPreferenceRequest
38
+ * SMSMfaSettings: { // SMSMfaSettingsType
39
+ * Enabled: true || false,
40
+ * PreferredMfa: true || false,
41
+ * },
42
+ * SoftwareTokenMfaSettings: { // SoftwareTokenMfaSettingsType
43
+ * Enabled: true || false,
44
+ * PreferredMfa: true || false,
45
+ * },
46
+ * AccessToken: "STRING_VALUE", // required
47
+ * };
37
48
  * const command = new SetUserMFAPreferenceCommand(input);
38
49
  * const response = await client.send(command);
39
50
  * ```
@@ -44,6 +44,21 @@ export interface SetUserPoolMfaConfigCommandOutput extends SetUserPoolMfaConfigR
44
44
  * import { CognitoIdentityProviderClient, SetUserPoolMfaConfigCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
45
45
  * // const { CognitoIdentityProviderClient, SetUserPoolMfaConfigCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
46
46
  * const client = new CognitoIdentityProviderClient(config);
47
+ * const input = { // SetUserPoolMfaConfigRequest
48
+ * UserPoolId: "STRING_VALUE", // required
49
+ * SmsMfaConfiguration: { // SmsMfaConfigType
50
+ * SmsAuthenticationMessage: "STRING_VALUE",
51
+ * SmsConfiguration: { // SmsConfigurationType
52
+ * SnsCallerArn: "STRING_VALUE", // required
53
+ * ExternalId: "STRING_VALUE",
54
+ * SnsRegion: "STRING_VALUE",
55
+ * },
56
+ * },
57
+ * SoftwareTokenMfaConfiguration: { // SoftwareTokenMfaConfigType
58
+ * Enabled: true || false,
59
+ * },
60
+ * MfaConfiguration: "OFF" || "ON" || "OPTIONAL",
61
+ * };
47
62
  * const command = new SetUserPoolMfaConfigCommand(input);
48
63
  * const response = await client.send(command);
49
64
  * ```
@@ -29,6 +29,15 @@ export interface SetUserSettingsCommandOutput extends SetUserSettingsResponse, _
29
29
  * import { CognitoIdentityProviderClient, SetUserSettingsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
30
30
  * // const { CognitoIdentityProviderClient, SetUserSettingsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
31
31
  * const client = new CognitoIdentityProviderClient(config);
32
+ * const input = { // SetUserSettingsRequest
33
+ * AccessToken: "STRING_VALUE", // required
34
+ * MFAOptions: [ // MFAOptionListType // required
35
+ * { // MFAOptionType
36
+ * DeliveryMedium: "SMS" || "EMAIL",
37
+ * AttributeName: "STRING_VALUE",
38
+ * },
39
+ * ],
40
+ * };
32
41
  * const command = new SetUserSettingsCommand(input);
33
42
  * const response = await client.send(command);
34
43
  * ```
@@ -45,6 +45,34 @@ export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {
45
45
  * import { CognitoIdentityProviderClient, SignUpCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
46
46
  * // const { CognitoIdentityProviderClient, SignUpCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
47
47
  * const client = new CognitoIdentityProviderClient(config);
48
+ * const input = { // SignUpRequest
49
+ * ClientId: "STRING_VALUE", // required
50
+ * SecretHash: "STRING_VALUE",
51
+ * Username: "STRING_VALUE", // required
52
+ * Password: "STRING_VALUE", // required
53
+ * UserAttributes: [ // AttributeListType
54
+ * { // AttributeType
55
+ * Name: "STRING_VALUE", // required
56
+ * Value: "STRING_VALUE",
57
+ * },
58
+ * ],
59
+ * ValidationData: [
60
+ * {
61
+ * Name: "STRING_VALUE", // required
62
+ * Value: "STRING_VALUE",
63
+ * },
64
+ * ],
65
+ * AnalyticsMetadata: { // AnalyticsMetadataType
66
+ * AnalyticsEndpointId: "STRING_VALUE",
67
+ * },
68
+ * UserContextData: { // UserContextDataType
69
+ * IpAddress: "STRING_VALUE",
70
+ * EncodedData: "STRING_VALUE",
71
+ * },
72
+ * ClientMetadata: { // ClientMetadataType
73
+ * "<keys>": "STRING_VALUE",
74
+ * },
75
+ * };
48
76
  * const command = new SignUpCommand(input);
49
77
  * const response = await client.send(command);
50
78
  * ```
@@ -26,6 +26,10 @@ export interface StartUserImportJobCommandOutput extends StartUserImportJobRespo
26
26
  * import { CognitoIdentityProviderClient, StartUserImportJobCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, StartUserImportJobCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = { // StartUserImportJobRequest
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * JobId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new StartUserImportJobCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface StopUserImportJobCommandOutput extends StopUserImportJobRespons
26
26
  * import { CognitoIdentityProviderClient, StopUserImportJobCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, StopUserImportJobCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = { // StopUserImportJobRequest
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * JobId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new StopUserImportJobCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -39,6 +39,12 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
39
39
  * import { CognitoIdentityProviderClient, TagResourceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
40
40
  * // const { CognitoIdentityProviderClient, TagResourceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
41
41
  * const client = new CognitoIdentityProviderClient(config);
42
+ * const input = { // TagResourceRequest
43
+ * ResourceArn: "STRING_VALUE", // required
44
+ * Tags: { // UserPoolTagsType // required
45
+ * "<keys>": "STRING_VALUE",
46
+ * },
47
+ * };
42
48
  * const command = new TagResourceCommand(input);
43
49
  * const response = await client.send(command);
44
50
  * ```
@@ -27,6 +27,12 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
27
27
  * import { CognitoIdentityProviderClient, UntagResourceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, UntagResourceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
29
29
  * const client = new CognitoIdentityProviderClient(config);
30
+ * const input = { // UntagResourceRequest
31
+ * ResourceArn: "STRING_VALUE", // required
32
+ * TagKeys: [ // UserPoolTagsListType // required
33
+ * "STRING_VALUE",
34
+ * ],
35
+ * };
30
36
  * const command = new UntagResourceCommand(input);
31
37
  * const response = await client.send(command);
32
38
  * ```
@@ -28,6 +28,13 @@ export interface UpdateAuthEventFeedbackCommandOutput extends UpdateAuthEventFee
28
28
  * import { CognitoIdentityProviderClient, UpdateAuthEventFeedbackCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
29
29
  * // const { CognitoIdentityProviderClient, UpdateAuthEventFeedbackCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
30
30
  * const client = new CognitoIdentityProviderClient(config);
31
+ * const input = { // UpdateAuthEventFeedbackRequest
32
+ * UserPoolId: "STRING_VALUE", // required
33
+ * Username: "STRING_VALUE", // required
34
+ * EventId: "STRING_VALUE", // required
35
+ * FeedbackToken: "STRING_VALUE", // required
36
+ * FeedbackValue: "Valid" || "Invalid", // required
37
+ * };
31
38
  * const command = new UpdateAuthEventFeedbackCommand(input);
32
39
  * const response = await client.send(command);
33
40
  * ```
@@ -26,6 +26,11 @@ export interface UpdateDeviceStatusCommandOutput extends UpdateDeviceStatusRespo
26
26
  * import { CognitoIdentityProviderClient, UpdateDeviceStatusCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, UpdateDeviceStatusCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = { // UpdateDeviceStatusRequest
30
+ * AccessToken: "STRING_VALUE", // required
31
+ * DeviceKey: "STRING_VALUE", // required
32
+ * DeviceRememberedStatus: "remembered" || "not_remembered",
33
+ * };
29
34
  * const command = new UpdateDeviceStatusCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -27,6 +27,13 @@ export interface UpdateGroupCommandOutput extends UpdateGroupResponse, __Metadat
27
27
  * import { CognitoIdentityProviderClient, UpdateGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, UpdateGroupCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
29
29
  * const client = new CognitoIdentityProviderClient(config);
30
+ * const input = { // UpdateGroupRequest
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 UpdateGroupCommand(input);
31
38
  * const response = await client.send(command);
32
39
  * ```
@@ -26,6 +26,19 @@ export interface UpdateIdentityProviderCommandOutput extends UpdateIdentityProvi
26
26
  * import { CognitoIdentityProviderClient, UpdateIdentityProviderCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, UpdateIdentityProviderCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = { // UpdateIdentityProviderRequest
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * ProviderName: "STRING_VALUE", // required
32
+ * ProviderDetails: { // ProviderDetailsType
33
+ * "<keys>": "STRING_VALUE",
34
+ * },
35
+ * AttributeMapping: { // AttributeMappingType
36
+ * "<keys>": "STRING_VALUE",
37
+ * },
38
+ * IdpIdentifiers: [ // IdpIdentifiersListType
39
+ * "STRING_VALUE",
40
+ * ],
41
+ * };
29
42
  * const command = new UpdateIdentityProviderCommand(input);
30
43
  * const response = await client.send(command);
31
44
  * ```
@@ -30,6 +30,17 @@ export interface UpdateResourceServerCommandOutput extends UpdateResourceServerR
30
30
  * import { CognitoIdentityProviderClient, UpdateResourceServerCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
31
31
  * // const { CognitoIdentityProviderClient, UpdateResourceServerCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
32
32
  * const client = new CognitoIdentityProviderClient(config);
33
+ * const input = { // UpdateResourceServerRequest
34
+ * UserPoolId: "STRING_VALUE", // required
35
+ * Identifier: "STRING_VALUE", // required
36
+ * Name: "STRING_VALUE", // required
37
+ * Scopes: [ // ResourceServerScopeListType
38
+ * { // ResourceServerScopeType
39
+ * ScopeName: "STRING_VALUE", // required
40
+ * ScopeDescription: "STRING_VALUE", // required
41
+ * },
42
+ * ],
43
+ * };
33
44
  * const command = new UpdateResourceServerCommand(input);
34
45
  * const response = await client.send(command);
35
46
  * ```
@@ -44,6 +44,18 @@ export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesR
44
44
  * import { CognitoIdentityProviderClient, UpdateUserAttributesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
45
45
  * // const { CognitoIdentityProviderClient, UpdateUserAttributesCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
46
46
  * const client = new CognitoIdentityProviderClient(config);
47
+ * const input = { // UpdateUserAttributesRequest
48
+ * UserAttributes: [ // AttributeListType // required
49
+ * { // AttributeType
50
+ * Name: "STRING_VALUE", // required
51
+ * Value: "STRING_VALUE",
52
+ * },
53
+ * ],
54
+ * AccessToken: "STRING_VALUE", // required
55
+ * ClientMetadata: { // ClientMetadataType
56
+ * "<keys>": "STRING_VALUE",
57
+ * },
58
+ * };
47
59
  * const command = new UpdateUserAttributesCommand(input);
48
60
  * const response = await client.send(command);
49
61
  * ```
@@ -33,6 +33,56 @@ export interface UpdateUserPoolClientCommandOutput extends UpdateUserPoolClientR
33
33
  * import { CognitoIdentityProviderClient, UpdateUserPoolClientCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
34
34
  * // const { CognitoIdentityProviderClient, UpdateUserPoolClientCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
35
35
  * const client = new CognitoIdentityProviderClient(config);
36
+ * const input = { // UpdateUserPoolClientRequest
37
+ * UserPoolId: "STRING_VALUE", // required
38
+ * ClientId: "STRING_VALUE", // required
39
+ * ClientName: "STRING_VALUE",
40
+ * RefreshTokenValidity: Number("int"),
41
+ * AccessTokenValidity: Number("int"),
42
+ * IdTokenValidity: Number("int"),
43
+ * TokenValidityUnits: { // TokenValidityUnitsType
44
+ * AccessToken: "seconds" || "minutes" || "hours" || "days",
45
+ * IdToken: "seconds" || "minutes" || "hours" || "days",
46
+ * RefreshToken: "seconds" || "minutes" || "hours" || "days",
47
+ * },
48
+ * ReadAttributes: [ // ClientPermissionListType
49
+ * "STRING_VALUE",
50
+ * ],
51
+ * WriteAttributes: [
52
+ * "STRING_VALUE",
53
+ * ],
54
+ * ExplicitAuthFlows: [ // ExplicitAuthFlowsListType
55
+ * "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",
56
+ * ],
57
+ * SupportedIdentityProviders: [ // SupportedIdentityProvidersListType
58
+ * "STRING_VALUE",
59
+ * ],
60
+ * CallbackURLs: [ // CallbackURLsListType
61
+ * "STRING_VALUE",
62
+ * ],
63
+ * LogoutURLs: [ // LogoutURLsListType
64
+ * "STRING_VALUE",
65
+ * ],
66
+ * DefaultRedirectURI: "STRING_VALUE",
67
+ * AllowedOAuthFlows: [ // OAuthFlowsType
68
+ * "code" || "implicit" || "client_credentials",
69
+ * ],
70
+ * AllowedOAuthScopes: [ // ScopeListType
71
+ * "STRING_VALUE",
72
+ * ],
73
+ * AllowedOAuthFlowsUserPoolClient: true || false,
74
+ * AnalyticsConfiguration: { // AnalyticsConfigurationType
75
+ * ApplicationId: "STRING_VALUE",
76
+ * ApplicationArn: "STRING_VALUE",
77
+ * RoleArn: "STRING_VALUE",
78
+ * ExternalId: "STRING_VALUE",
79
+ * UserDataShared: true || false,
80
+ * },
81
+ * PreventUserExistenceErrors: "LEGACY" || "ENABLED",
82
+ * EnableTokenRevocation: true || false,
83
+ * EnablePropagateAdditionalUserContextData: true || false,
84
+ * AuthSessionValidity: Number("int"),
85
+ * };
36
86
  * const command = new UpdateUserPoolClientCommand(input);
37
87
  * const response = await client.send(command);
38
88
  * ```
@@ -47,6 +47,101 @@ export interface UpdateUserPoolCommandOutput extends UpdateUserPoolResponse, __M
47
47
  * import { CognitoIdentityProviderClient, UpdateUserPoolCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
48
48
  * // const { CognitoIdentityProviderClient, UpdateUserPoolCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
49
49
  * const client = new CognitoIdentityProviderClient(config);
50
+ * const input = { // UpdateUserPoolRequest
51
+ * UserPoolId: "STRING_VALUE", // required
52
+ * Policies: { // UserPoolPolicyType
53
+ * PasswordPolicy: { // PasswordPolicyType
54
+ * MinimumLength: Number("int"),
55
+ * RequireUppercase: true || false,
56
+ * RequireLowercase: true || false,
57
+ * RequireNumbers: true || false,
58
+ * RequireSymbols: true || false,
59
+ * TemporaryPasswordValidityDays: Number("int"),
60
+ * },
61
+ * },
62
+ * DeletionProtection: "ACTIVE" || "INACTIVE",
63
+ * LambdaConfig: { // LambdaConfigType
64
+ * PreSignUp: "STRING_VALUE",
65
+ * CustomMessage: "STRING_VALUE",
66
+ * PostConfirmation: "STRING_VALUE",
67
+ * PreAuthentication: "STRING_VALUE",
68
+ * PostAuthentication: "STRING_VALUE",
69
+ * DefineAuthChallenge: "STRING_VALUE",
70
+ * CreateAuthChallenge: "STRING_VALUE",
71
+ * VerifyAuthChallengeResponse: "STRING_VALUE",
72
+ * PreTokenGeneration: "STRING_VALUE",
73
+ * UserMigration: "STRING_VALUE",
74
+ * CustomSMSSender: { // CustomSMSLambdaVersionConfigType
75
+ * LambdaVersion: "V1_0", // required
76
+ * LambdaArn: "STRING_VALUE", // required
77
+ * },
78
+ * CustomEmailSender: { // CustomEmailLambdaVersionConfigType
79
+ * LambdaVersion: "V1_0", // required
80
+ * LambdaArn: "STRING_VALUE", // required
81
+ * },
82
+ * KMSKeyID: "STRING_VALUE",
83
+ * },
84
+ * AutoVerifiedAttributes: [ // VerifiedAttributesListType
85
+ * "phone_number" || "email",
86
+ * ],
87
+ * SmsVerificationMessage: "STRING_VALUE",
88
+ * EmailVerificationMessage: "STRING_VALUE",
89
+ * EmailVerificationSubject: "STRING_VALUE",
90
+ * VerificationMessageTemplate: { // VerificationMessageTemplateType
91
+ * SmsMessage: "STRING_VALUE",
92
+ * EmailMessage: "STRING_VALUE",
93
+ * EmailSubject: "STRING_VALUE",
94
+ * EmailMessageByLink: "STRING_VALUE",
95
+ * EmailSubjectByLink: "STRING_VALUE",
96
+ * DefaultEmailOption: "CONFIRM_WITH_LINK" || "CONFIRM_WITH_CODE",
97
+ * },
98
+ * SmsAuthenticationMessage: "STRING_VALUE",
99
+ * UserAttributeUpdateSettings: { // UserAttributeUpdateSettingsType
100
+ * AttributesRequireVerificationBeforeUpdate: [ // AttributesRequireVerificationBeforeUpdateType
101
+ * "phone_number" || "email",
102
+ * ],
103
+ * },
104
+ * MfaConfiguration: "OFF" || "ON" || "OPTIONAL",
105
+ * DeviceConfiguration: { // DeviceConfigurationType
106
+ * ChallengeRequiredOnNewDevice: true || false,
107
+ * DeviceOnlyRememberedOnUserPrompt: true || false,
108
+ * },
109
+ * EmailConfiguration: { // EmailConfigurationType
110
+ * SourceArn: "STRING_VALUE",
111
+ * ReplyToEmailAddress: "STRING_VALUE",
112
+ * EmailSendingAccount: "COGNITO_DEFAULT" || "DEVELOPER",
113
+ * From: "STRING_VALUE",
114
+ * ConfigurationSet: "STRING_VALUE",
115
+ * },
116
+ * SmsConfiguration: { // SmsConfigurationType
117
+ * SnsCallerArn: "STRING_VALUE", // required
118
+ * ExternalId: "STRING_VALUE",
119
+ * SnsRegion: "STRING_VALUE",
120
+ * },
121
+ * UserPoolTags: { // UserPoolTagsType
122
+ * "<keys>": "STRING_VALUE",
123
+ * },
124
+ * AdminCreateUserConfig: { // AdminCreateUserConfigType
125
+ * AllowAdminCreateUserOnly: true || false,
126
+ * UnusedAccountValidityDays: Number("int"),
127
+ * InviteMessageTemplate: { // MessageTemplateType
128
+ * SMSMessage: "STRING_VALUE",
129
+ * EmailMessage: "STRING_VALUE",
130
+ * EmailSubject: "STRING_VALUE",
131
+ * },
132
+ * },
133
+ * UserPoolAddOns: { // UserPoolAddOnsType
134
+ * AdvancedSecurityMode: "OFF" || "AUDIT" || "ENFORCED", // required
135
+ * },
136
+ * AccountRecoverySetting: { // AccountRecoverySettingType
137
+ * RecoveryMechanisms: [ // RecoveryMechanismsType
138
+ * { // RecoveryOptionType
139
+ * Priority: Number("int"), // required
140
+ * Name: "verified_email" || "verified_phone_number" || "admin_only", // required
141
+ * },
142
+ * ],
143
+ * },
144
+ * };
50
145
  * const command = new UpdateUserPoolCommand(input);
51
146
  * const response = await client.send(command);
52
147
  * ```