@aws-sdk/client-cognito-identity-provider 3.321.1 → 3.326.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 +4 -0
  2. package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +4 -0
  3. package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +4 -0
  4. package/dist-types/commands/AdminCreateUserCommand.d.ts +24 -0
  5. package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +4 -0
  6. package/dist-types/commands/AdminDeleteUserCommand.d.ts +4 -0
  7. package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +4 -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 +4 -0
  11. package/dist-types/commands/AdminGetDeviceCommand.d.ts +17 -0
  12. package/dist-types/commands/AdminGetUserCommand.d.ts +26 -0
  13. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +21 -0
  14. package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +4 -0
  15. package/dist-types/commands/AdminListDevicesCommand.d.ts +20 -0
  16. package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +17 -0
  17. package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +37 -0
  18. package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +4 -0
  19. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +4 -0
  20. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +21 -0
  21. package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +4 -0
  22. package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +4 -0
  23. package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +4 -0
  24. package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +4 -0
  25. package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +4 -0
  26. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +4 -0
  27. package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +4 -0
  28. package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +7 -0
  29. package/dist-types/commands/ChangePasswordCommand.d.ts +4 -0
  30. package/dist-types/commands/ConfirmDeviceCommand.d.ts +6 -0
  31. package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +4 -0
  32. package/dist-types/commands/ConfirmSignUpCommand.d.ts +4 -0
  33. package/dist-types/commands/CreateGroupCommand.d.ts +14 -0
  34. package/dist-types/commands/CreateIdentityProviderCommand.d.ts +21 -0
  35. package/dist-types/commands/CreateResourceServerCommand.d.ts +16 -0
  36. package/dist-types/commands/CreateUserImportJobCommand.d.ts +20 -0
  37. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +58 -0
  38. package/dist-types/commands/CreateUserPoolCommand.d.ts +136 -0
  39. package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +6 -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 +4 -0
  44. package/dist-types/commands/DeleteUserCommand.d.ts +4 -0
  45. package/dist-types/commands/DeleteUserPoolClientCommand.d.ts +4 -0
  46. package/dist-types/commands/DeleteUserPoolCommand.d.ts +4 -0
  47. package/dist-types/commands/DeleteUserPoolDomainCommand.d.ts +4 -0
  48. package/dist-types/commands/DescribeIdentityProviderCommand.d.ts +21 -0
  49. package/dist-types/commands/DescribeResourceServerCommand.d.ts +16 -0
  50. package/dist-types/commands/DescribeRiskConfigurationCommand.d.ts +62 -0
  51. package/dist-types/commands/DescribeUserImportJobCommand.d.ts +20 -0
  52. package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +58 -0
  53. package/dist-types/commands/DescribeUserPoolCommand.d.ts +136 -0
  54. package/dist-types/commands/DescribeUserPoolDomainCommand.d.ts +17 -0
  55. package/dist-types/commands/ForgetDeviceCommand.d.ts +4 -0
  56. package/dist-types/commands/ForgotPasswordCommand.d.ts +10 -0
  57. package/dist-types/commands/GetCSVHeaderCommand.d.ts +9 -0
  58. package/dist-types/commands/GetDeviceCommand.d.ts +17 -0
  59. package/dist-types/commands/GetGroupCommand.d.ts +14 -0
  60. package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts +21 -0
  61. package/dist-types/commands/GetSigningCertificateCommand.d.ts +6 -0
  62. package/dist-types/commands/GetUICustomizationCommand.d.ts +14 -0
  63. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +10 -0
  64. package/dist-types/commands/GetUserCommand.d.ts +22 -0
  65. package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +17 -0
  66. package/dist-types/commands/GlobalSignOutCommand.d.ts +4 -0
  67. package/dist-types/commands/InitiateAuthCommand.d.ts +21 -0
  68. package/dist-types/commands/ListDevicesCommand.d.ts +20 -0
  69. package/dist-types/commands/ListGroupsCommand.d.ts +17 -0
  70. package/dist-types/commands/ListIdentityProvidersCommand.d.ts +14 -0
  71. package/dist-types/commands/ListResourceServersCommand.d.ts +19 -0
  72. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  73. package/dist-types/commands/ListUserImportJobsCommand.d.ts +23 -0
  74. package/dist-types/commands/ListUserPoolClientsCommand.d.ts +13 -0
  75. package/dist-types/commands/ListUserPoolsCommand.d.ts +36 -0
  76. package/dist-types/commands/ListUsersCommand.d.ts +27 -0
  77. package/dist-types/commands/ListUsersInGroupCommand.d.ts +27 -0
  78. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +10 -0
  79. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +21 -0
  80. package/dist-types/commands/RevokeTokenCommand.d.ts +4 -0
  81. package/dist-types/commands/SetRiskConfigurationCommand.d.ts +62 -0
  82. package/dist-types/commands/SetUICustomizationCommand.d.ts +14 -0
  83. package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +4 -0
  84. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +17 -0
  85. package/dist-types/commands/SetUserSettingsCommand.d.ts +4 -0
  86. package/dist-types/commands/SignUpCommand.d.ts +12 -0
  87. package/dist-types/commands/StartUserImportJobCommand.d.ts +20 -0
  88. package/dist-types/commands/StopUserImportJobCommand.d.ts +20 -0
  89. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  90. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  91. package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +4 -0
  92. package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +4 -0
  93. package/dist-types/commands/UpdateGroupCommand.d.ts +14 -0
  94. package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +21 -0
  95. package/dist-types/commands/UpdateResourceServerCommand.d.ts +16 -0
  96. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +12 -0
  97. package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +58 -0
  98. package/dist-types/commands/UpdateUserPoolCommand.d.ts +4 -0
  99. package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +6 -0
  100. package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +7 -0
  101. package/dist-types/commands/VerifyUserAttributeCommand.d.ts +4 -0
  102. package/package.json +16 -16
@@ -46,6 +46,18 @@ export interface SetUICustomizationCommandOutput extends SetUICustomizationRespo
46
46
  * };
47
47
  * const command = new SetUICustomizationCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // { // SetUICustomizationResponse
50
+ * // UICustomization: { // UICustomizationType
51
+ * // UserPoolId: "STRING_VALUE",
52
+ * // ClientId: "STRING_VALUE",
53
+ * // ImageUrl: "STRING_VALUE",
54
+ * // CSS: "STRING_VALUE",
55
+ * // CSSVersion: "STRING_VALUE",
56
+ * // LastModifiedDate: new Date("TIMESTAMP"),
57
+ * // CreationDate: new Date("TIMESTAMP"),
58
+ * // },
59
+ * // };
60
+ *
49
61
  * ```
50
62
  *
51
63
  * @param SetUICustomizationCommandInput - {@link SetUICustomizationCommandInput}
@@ -72,6 +84,8 @@ export interface SetUICustomizationCommandOutput extends SetUICustomizationRespo
72
84
  * <p>This exception is thrown when the user has made too many requests for a given
73
85
  * operation.</p>
74
86
  *
87
+ * @throws {@link CognitoIdentityProviderServiceException}
88
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
75
89
  *
76
90
  */
77
91
  export declare class SetUICustomizationCommand extends $Command<SetUICustomizationCommandInput, SetUICustomizationCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -47,6 +47,8 @@ export interface SetUserMFAPreferenceCommandOutput extends SetUserMFAPreferenceR
47
47
  * };
48
48
  * const command = new SetUserMFAPreferenceCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // {};
51
+ *
50
52
  * ```
51
53
  *
52
54
  * @param SetUserMFAPreferenceCommandInput - {@link SetUserMFAPreferenceCommandInput}
@@ -81,6 +83,8 @@ export interface SetUserMFAPreferenceCommandOutput extends SetUserMFAPreferenceR
81
83
  * @throws {@link UserNotFoundException} (client fault)
82
84
  * <p>This exception is thrown when a user isn't found.</p>
83
85
  *
86
+ * @throws {@link CognitoIdentityProviderServiceException}
87
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
84
88
  *
85
89
  */
86
90
  export declare class SetUserMFAPreferenceCommand extends $Command<SetUserMFAPreferenceCommandInput, SetUserMFAPreferenceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -61,6 +61,21 @@ export interface SetUserPoolMfaConfigCommandOutput extends SetUserPoolMfaConfigR
61
61
  * };
62
62
  * const command = new SetUserPoolMfaConfigCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // SetUserPoolMfaConfigResponse
65
+ * // SmsMfaConfiguration: { // SmsMfaConfigType
66
+ * // SmsAuthenticationMessage: "STRING_VALUE",
67
+ * // SmsConfiguration: { // SmsConfigurationType
68
+ * // SnsCallerArn: "STRING_VALUE", // required
69
+ * // ExternalId: "STRING_VALUE",
70
+ * // SnsRegion: "STRING_VALUE",
71
+ * // },
72
+ * // },
73
+ * // SoftwareTokenMfaConfiguration: { // SoftwareTokenMfaConfigType
74
+ * // Enabled: true || false,
75
+ * // },
76
+ * // MfaConfiguration: "OFF" || "ON" || "OPTIONAL",
77
+ * // };
78
+ *
64
79
  * ```
65
80
  *
66
81
  * @param SetUserPoolMfaConfigCommandInput - {@link SetUserPoolMfaConfigCommandInput}
@@ -97,6 +112,8 @@ export interface SetUserPoolMfaConfigCommandOutput extends SetUserPoolMfaConfigR
97
112
  * <p>This exception is thrown when the user has made too many requests for a given
98
113
  * operation.</p>
99
114
  *
115
+ * @throws {@link CognitoIdentityProviderServiceException}
116
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
100
117
  *
101
118
  */
102
119
  export declare class SetUserPoolMfaConfigCommand extends $Command<SetUserPoolMfaConfigCommandInput, SetUserPoolMfaConfigCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -40,6 +40,8 @@ export interface SetUserSettingsCommandOutput extends SetUserSettingsResponse, _
40
40
  * };
41
41
  * const command = new SetUserSettingsCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // {};
44
+ *
43
45
  * ```
44
46
  *
45
47
  * @param SetUserSettingsCommandInput - {@link SetUserSettingsCommandInput}
@@ -74,6 +76,8 @@ export interface SetUserSettingsCommandOutput extends SetUserSettingsResponse, _
74
76
  * @throws {@link UserNotFoundException} (client fault)
75
77
  * <p>This exception is thrown when a user isn't found.</p>
76
78
  *
79
+ * @throws {@link CognitoIdentityProviderServiceException}
80
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
77
81
  *
78
82
  */
79
83
  export declare class SetUserSettingsCommand extends $Command<SetUserSettingsCommandInput, SetUserSettingsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -75,6 +75,16 @@ export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {
75
75
  * };
76
76
  * const command = new SignUpCommand(input);
77
77
  * const response = await client.send(command);
78
+ * // { // SignUpResponse
79
+ * // UserConfirmed: true || false, // required
80
+ * // CodeDeliveryDetails: { // CodeDeliveryDetailsType
81
+ * // Destination: "STRING_VALUE",
82
+ * // DeliveryMedium: "SMS" || "EMAIL",
83
+ * // AttributeName: "STRING_VALUE",
84
+ * // },
85
+ * // UserSub: "STRING_VALUE", // required
86
+ * // };
87
+ *
78
88
  * ```
79
89
  *
80
90
  * @param SignUpCommandInput - {@link SignUpCommandInput}
@@ -140,6 +150,8 @@ export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {
140
150
  * <p>This exception is thrown when Amazon Cognito encounters a user name that already
141
151
  * exists in the user pool.</p>
142
152
  *
153
+ * @throws {@link CognitoIdentityProviderServiceException}
154
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
143
155
  *
144
156
  */
145
157
  export declare class SignUpCommand extends $Command<SignUpCommandInput, SignUpCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -32,6 +32,24 @@ export interface StartUserImportJobCommandOutput extends StartUserImportJobRespo
32
32
  * };
33
33
  * const command = new StartUserImportJobCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // StartUserImportJobResponse
36
+ * // UserImportJob: { // UserImportJobType
37
+ * // JobName: "STRING_VALUE",
38
+ * // JobId: "STRING_VALUE",
39
+ * // UserPoolId: "STRING_VALUE",
40
+ * // PreSignedUrl: "STRING_VALUE",
41
+ * // CreationDate: new Date("TIMESTAMP"),
42
+ * // StartDate: new Date("TIMESTAMP"),
43
+ * // CompletionDate: new Date("TIMESTAMP"),
44
+ * // Status: "Created" || "Pending" || "InProgress" || "Stopping" || "Expired" || "Stopped" || "Failed" || "Succeeded",
45
+ * // CloudWatchLogsRoleArn: "STRING_VALUE",
46
+ * // ImportedUsers: Number("long"),
47
+ * // SkippedUsers: Number("long"),
48
+ * // FailedUsers: Number("long"),
49
+ * // CompletionMessage: "STRING_VALUE",
50
+ * // },
51
+ * // };
52
+ *
35
53
  * ```
36
54
  *
37
55
  * @param StartUserImportJobCommandInput - {@link StartUserImportJobCommandInput}
@@ -61,6 +79,8 @@ export interface StartUserImportJobCommandOutput extends StartUserImportJobRespo
61
79
  * <p>This exception is thrown when the user has made too many requests for a given
62
80
  * operation.</p>
63
81
  *
82
+ * @throws {@link CognitoIdentityProviderServiceException}
83
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
64
84
  *
65
85
  */
66
86
  export declare class StartUserImportJobCommand extends $Command<StartUserImportJobCommandInput, StartUserImportJobCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -32,6 +32,24 @@ export interface StopUserImportJobCommandOutput extends StopUserImportJobRespons
32
32
  * };
33
33
  * const command = new StopUserImportJobCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // StopUserImportJobResponse
36
+ * // UserImportJob: { // UserImportJobType
37
+ * // JobName: "STRING_VALUE",
38
+ * // JobId: "STRING_VALUE",
39
+ * // UserPoolId: "STRING_VALUE",
40
+ * // PreSignedUrl: "STRING_VALUE",
41
+ * // CreationDate: new Date("TIMESTAMP"),
42
+ * // StartDate: new Date("TIMESTAMP"),
43
+ * // CompletionDate: new Date("TIMESTAMP"),
44
+ * // Status: "Created" || "Pending" || "InProgress" || "Stopping" || "Expired" || "Stopped" || "Failed" || "Succeeded",
45
+ * // CloudWatchLogsRoleArn: "STRING_VALUE",
46
+ * // ImportedUsers: Number("long"),
47
+ * // SkippedUsers: Number("long"),
48
+ * // FailedUsers: Number("long"),
49
+ * // CompletionMessage: "STRING_VALUE",
50
+ * // },
51
+ * // };
52
+ *
35
53
  * ```
36
54
  *
37
55
  * @param StopUserImportJobCommandInput - {@link StopUserImportJobCommandInput}
@@ -61,6 +79,8 @@ export interface StopUserImportJobCommandOutput extends StopUserImportJobRespons
61
79
  * <p>This exception is thrown when the user has made too many requests for a given
62
80
  * operation.</p>
63
81
  *
82
+ * @throws {@link CognitoIdentityProviderServiceException}
83
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
64
84
  *
65
85
  */
66
86
  export declare class StopUserImportJobCommand extends $Command<StopUserImportJobCommandInput, StopUserImportJobCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -47,6 +47,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
47
47
  * };
48
48
  * const command = new TagResourceCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // {};
51
+ *
50
52
  * ```
51
53
  *
52
54
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -73,6 +75,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
73
75
  * <p>This exception is thrown when the user has made too many requests for a given
74
76
  * operation.</p>
75
77
  *
78
+ * @throws {@link CognitoIdentityProviderServiceException}
79
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
76
80
  *
77
81
  */
78
82
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
35
35
  * };
36
36
  * const command = new UntagResourceCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -61,6 +63,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
61
63
  * <p>This exception is thrown when the user has made too many requests for a given
62
64
  * operation.</p>
63
65
  *
66
+ * @throws {@link CognitoIdentityProviderServiceException}
67
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
64
68
  *
65
69
  */
66
70
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -37,6 +37,8 @@ export interface UpdateAuthEventFeedbackCommandOutput extends UpdateAuthEventFee
37
37
  * };
38
38
  * const command = new UpdateAuthEventFeedbackCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param UpdateAuthEventFeedbackCommandInput - {@link UpdateAuthEventFeedbackCommandInput}
@@ -69,6 +71,8 @@ export interface UpdateAuthEventFeedbackCommandOutput extends UpdateAuthEventFee
69
71
  * @throws {@link UserPoolAddOnNotEnabledException} (client fault)
70
72
  * <p>This exception is thrown when user pool add-ons aren't enabled.</p>
71
73
  *
74
+ * @throws {@link CognitoIdentityProviderServiceException}
75
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
72
76
  *
73
77
  */
74
78
  export declare class UpdateAuthEventFeedbackCommand extends $Command<UpdateAuthEventFeedbackCommandInput, UpdateAuthEventFeedbackCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface UpdateDeviceStatusCommandOutput extends UpdateDeviceStatusRespo
33
33
  * };
34
34
  * const command = new UpdateDeviceStatusCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param UpdateDeviceStatusCommandInput - {@link UpdateDeviceStatusCommandInput}
@@ -74,6 +76,8 @@ export interface UpdateDeviceStatusCommandOutput extends UpdateDeviceStatusRespo
74
76
  * @throws {@link UserNotFoundException} (client fault)
75
77
  * <p>This exception is thrown when a user isn't found.</p>
76
78
  *
79
+ * @throws {@link CognitoIdentityProviderServiceException}
80
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
77
81
  *
78
82
  */
79
83
  export declare class UpdateDeviceStatusCommand extends $Command<UpdateDeviceStatusCommandInput, UpdateDeviceStatusCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -36,6 +36,18 @@ export interface UpdateGroupCommandOutput extends UpdateGroupResponse, __Metadat
36
36
  * };
37
37
  * const command = new UpdateGroupCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // UpdateGroupResponse
40
+ * // Group: { // GroupType
41
+ * // GroupName: "STRING_VALUE",
42
+ * // UserPoolId: "STRING_VALUE",
43
+ * // Description: "STRING_VALUE",
44
+ * // RoleArn: "STRING_VALUE",
45
+ * // Precedence: Number("int"),
46
+ * // LastModifiedDate: new Date("TIMESTAMP"),
47
+ * // CreationDate: new Date("TIMESTAMP"),
48
+ * // },
49
+ * // };
50
+ *
39
51
  * ```
40
52
  *
41
53
  * @param UpdateGroupCommandInput - {@link UpdateGroupCommandInput}
@@ -62,6 +74,8 @@ export interface UpdateGroupCommandOutput extends UpdateGroupResponse, __Metadat
62
74
  * <p>This exception is thrown when the user has made too many requests for a given
63
75
  * operation.</p>
64
76
  *
77
+ * @throws {@link CognitoIdentityProviderServiceException}
78
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
65
79
  *
66
80
  */
67
81
  export declare class UpdateGroupCommand extends $Command<UpdateGroupCommandInput, UpdateGroupCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -41,6 +41,25 @@ export interface UpdateIdentityProviderCommandOutput extends UpdateIdentityProvi
41
41
  * };
42
42
  * const command = new UpdateIdentityProviderCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // UpdateIdentityProviderResponse
45
+ * // IdentityProvider: { // IdentityProviderType
46
+ * // UserPoolId: "STRING_VALUE",
47
+ * // ProviderName: "STRING_VALUE",
48
+ * // ProviderType: "SAML" || "Facebook" || "Google" || "LoginWithAmazon" || "SignInWithApple" || "OIDC",
49
+ * // ProviderDetails: { // ProviderDetailsType
50
+ * // "<keys>": "STRING_VALUE",
51
+ * // },
52
+ * // AttributeMapping: { // AttributeMappingType
53
+ * // "<keys>": "STRING_VALUE",
54
+ * // },
55
+ * // IdpIdentifiers: [ // IdpIdentifiersListType
56
+ * // "STRING_VALUE",
57
+ * // ],
58
+ * // LastModifiedDate: new Date("TIMESTAMP"),
59
+ * // CreationDate: new Date("TIMESTAMP"),
60
+ * // },
61
+ * // };
62
+ *
44
63
  * ```
45
64
  *
46
65
  * @param UpdateIdentityProviderCommandInput - {@link UpdateIdentityProviderCommandInput}
@@ -74,6 +93,8 @@ export interface UpdateIdentityProviderCommandOutput extends UpdateIdentityProvi
74
93
  * @throws {@link UnsupportedIdentityProviderException} (client fault)
75
94
  * <p>This exception is thrown when the specified identifier isn't supported.</p>
76
95
  *
96
+ * @throws {@link CognitoIdentityProviderServiceException}
97
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
77
98
  *
78
99
  */
79
100
  export declare class UpdateIdentityProviderCommand extends $Command<UpdateIdentityProviderCommandInput, UpdateIdentityProviderCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -43,6 +43,20 @@ export interface UpdateResourceServerCommandOutput extends UpdateResourceServerR
43
43
  * };
44
44
  * const command = new UpdateResourceServerCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // UpdateResourceServerResponse
47
+ * // ResourceServer: { // ResourceServerType
48
+ * // UserPoolId: "STRING_VALUE",
49
+ * // Identifier: "STRING_VALUE",
50
+ * // Name: "STRING_VALUE",
51
+ * // Scopes: [ // ResourceServerScopeListType
52
+ * // { // ResourceServerScopeType
53
+ * // ScopeName: "STRING_VALUE", // required
54
+ * // ScopeDescription: "STRING_VALUE", // required
55
+ * // },
56
+ * // ],
57
+ * // },
58
+ * // };
59
+ *
46
60
  * ```
47
61
  *
48
62
  * @param UpdateResourceServerCommandInput - {@link UpdateResourceServerCommandInput}
@@ -69,6 +83,8 @@ export interface UpdateResourceServerCommandOutput extends UpdateResourceServerR
69
83
  * <p>This exception is thrown when the user has made too many requests for a given
70
84
  * operation.</p>
71
85
  *
86
+ * @throws {@link CognitoIdentityProviderServiceException}
87
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
72
88
  *
73
89
  */
74
90
  export declare class UpdateResourceServerCommand extends $Command<UpdateResourceServerCommandInput, UpdateResourceServerCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -58,6 +58,16 @@ export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesR
58
58
  * };
59
59
  * const command = new UpdateUserAttributesCommand(input);
60
60
  * const response = await client.send(command);
61
+ * // { // UpdateUserAttributesResponse
62
+ * // CodeDeliveryDetailsList: [ // CodeDeliveryDetailsListType
63
+ * // { // CodeDeliveryDetailsType
64
+ * // Destination: "STRING_VALUE",
65
+ * // DeliveryMedium: "SMS" || "EMAIL",
66
+ * // AttributeName: "STRING_VALUE",
67
+ * // },
68
+ * // ],
69
+ * // };
70
+ *
61
71
  * ```
62
72
  *
63
73
  * @param UpdateUserAttributesCommandInput - {@link UpdateUserAttributesCommandInput}
@@ -139,6 +149,8 @@ export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesR
139
149
  * @throws {@link UserNotFoundException} (client fault)
140
150
  * <p>This exception is thrown when a user isn't found.</p>
141
151
  *
152
+ * @throws {@link CognitoIdentityProviderServiceException}
153
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
142
154
  *
143
155
  */
144
156
  export declare class UpdateUserAttributesCommand extends $Command<UpdateUserAttributesCommandInput, UpdateUserAttributesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -85,6 +85,62 @@ export interface UpdateUserPoolClientCommandOutput extends UpdateUserPoolClientR
85
85
  * };
86
86
  * const command = new UpdateUserPoolClientCommand(input);
87
87
  * const response = await client.send(command);
88
+ * // { // UpdateUserPoolClientResponse
89
+ * // UserPoolClient: { // UserPoolClientType
90
+ * // UserPoolId: "STRING_VALUE",
91
+ * // ClientName: "STRING_VALUE",
92
+ * // ClientId: "STRING_VALUE",
93
+ * // ClientSecret: "STRING_VALUE",
94
+ * // LastModifiedDate: new Date("TIMESTAMP"),
95
+ * // CreationDate: new Date("TIMESTAMP"),
96
+ * // RefreshTokenValidity: Number("int"),
97
+ * // AccessTokenValidity: Number("int"),
98
+ * // IdTokenValidity: Number("int"),
99
+ * // TokenValidityUnits: { // TokenValidityUnitsType
100
+ * // AccessToken: "seconds" || "minutes" || "hours" || "days",
101
+ * // IdToken: "seconds" || "minutes" || "hours" || "days",
102
+ * // RefreshToken: "seconds" || "minutes" || "hours" || "days",
103
+ * // },
104
+ * // ReadAttributes: [ // ClientPermissionListType
105
+ * // "STRING_VALUE",
106
+ * // ],
107
+ * // WriteAttributes: [
108
+ * // "STRING_VALUE",
109
+ * // ],
110
+ * // ExplicitAuthFlows: [ // ExplicitAuthFlowsListType
111
+ * // "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",
112
+ * // ],
113
+ * // SupportedIdentityProviders: [ // SupportedIdentityProvidersListType
114
+ * // "STRING_VALUE",
115
+ * // ],
116
+ * // CallbackURLs: [ // CallbackURLsListType
117
+ * // "STRING_VALUE",
118
+ * // ],
119
+ * // LogoutURLs: [ // LogoutURLsListType
120
+ * // "STRING_VALUE",
121
+ * // ],
122
+ * // DefaultRedirectURI: "STRING_VALUE",
123
+ * // AllowedOAuthFlows: [ // OAuthFlowsType
124
+ * // "code" || "implicit" || "client_credentials",
125
+ * // ],
126
+ * // AllowedOAuthScopes: [ // ScopeListType
127
+ * // "STRING_VALUE",
128
+ * // ],
129
+ * // AllowedOAuthFlowsUserPoolClient: true || false,
130
+ * // AnalyticsConfiguration: { // AnalyticsConfigurationType
131
+ * // ApplicationId: "STRING_VALUE",
132
+ * // ApplicationArn: "STRING_VALUE",
133
+ * // RoleArn: "STRING_VALUE",
134
+ * // ExternalId: "STRING_VALUE",
135
+ * // UserDataShared: true || false,
136
+ * // },
137
+ * // PreventUserExistenceErrors: "LEGACY" || "ENABLED",
138
+ * // EnableTokenRevocation: true || false,
139
+ * // EnablePropagateAdditionalUserContextData: true || false,
140
+ * // AuthSessionValidity: Number("int"),
141
+ * // },
142
+ * // };
143
+ *
88
144
  * ```
89
145
  *
90
146
  * @param UpdateUserPoolClientCommandInput - {@link UpdateUserPoolClientCommandInput}
@@ -121,6 +177,8 @@ export interface UpdateUserPoolClientCommandOutput extends UpdateUserPoolClientR
121
177
  * <p>This exception is thrown when the user has made too many requests for a given
122
178
  * operation.</p>
123
179
  *
180
+ * @throws {@link CognitoIdentityProviderServiceException}
181
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
124
182
  *
125
183
  */
126
184
  export declare class UpdateUserPoolClientCommand extends $Command<UpdateUserPoolClientCommandInput, UpdateUserPoolClientCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -144,6 +144,8 @@ export interface UpdateUserPoolCommandOutput extends UpdateUserPoolResponse, __M
144
144
  * };
145
145
  * const command = new UpdateUserPoolCommand(input);
146
146
  * const response = await client.send(command);
147
+ * // {};
148
+ *
147
149
  * ```
148
150
  *
149
151
  * @param UpdateUserPoolCommandInput - {@link UpdateUserPoolCommandInput}
@@ -195,6 +197,8 @@ export interface UpdateUserPoolCommandOutput extends UpdateUserPoolResponse, __M
195
197
  * @throws {@link UserPoolTaggingException} (client fault)
196
198
  * <p>This exception is thrown when a user pool tag can't be set or updated.</p>
197
199
  *
200
+ * @throws {@link CognitoIdentityProviderServiceException}
201
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
198
202
  *
199
203
  */
200
204
  export declare class UpdateUserPoolCommand extends $Command<UpdateUserPoolCommandInput, UpdateUserPoolCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -53,6 +53,10 @@ export interface UpdateUserPoolDomainCommandOutput extends UpdateUserPoolDomainR
53
53
  * };
54
54
  * const command = new UpdateUserPoolDomainCommand(input);
55
55
  * const response = await client.send(command);
56
+ * // { // UpdateUserPoolDomainResponse
57
+ * // CloudFrontDomain: "STRING_VALUE",
58
+ * // };
59
+ *
56
60
  * ```
57
61
  *
58
62
  * @param UpdateUserPoolDomainCommandInput - {@link UpdateUserPoolDomainCommandInput}
@@ -79,6 +83,8 @@ export interface UpdateUserPoolDomainCommandOutput extends UpdateUserPoolDomainR
79
83
  * <p>This exception is thrown when the user has made too many requests for a given
80
84
  * operation.</p>
81
85
  *
86
+ * @throws {@link CognitoIdentityProviderServiceException}
87
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
82
88
  *
83
89
  */
84
90
  export declare class UpdateUserPoolDomainCommand extends $Command<UpdateUserPoolDomainCommandInput, UpdateUserPoolDomainCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -36,6 +36,11 @@ export interface VerifySoftwareTokenCommandOutput extends VerifySoftwareTokenRes
36
36
  * };
37
37
  * const command = new VerifySoftwareTokenCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // VerifySoftwareTokenResponse
40
+ * // Status: "SUCCESS" || "ERROR",
41
+ * // Session: "STRING_VALUE",
42
+ * // };
43
+ *
39
44
  * ```
40
45
  *
41
46
  * @param VerifySoftwareTokenCommandInput - {@link VerifySoftwareTokenCommandInput}
@@ -89,6 +94,8 @@ export interface VerifySoftwareTokenCommandOutput extends VerifySoftwareTokenRes
89
94
  * @throws {@link UserNotFoundException} (client fault)
90
95
  * <p>This exception is thrown when a user isn't found.</p>
91
96
  *
97
+ * @throws {@link CognitoIdentityProviderServiceException}
98
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
92
99
  *
93
100
  */
94
101
  export declare class VerifySoftwareTokenCommand extends $Command<VerifySoftwareTokenCommandInput, VerifySoftwareTokenCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -39,6 +39,8 @@ export interface VerifyUserAttributeCommandOutput extends VerifyUserAttributeRes
39
39
  * };
40
40
  * const command = new VerifyUserAttributeCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // {};
43
+ *
42
44
  * ```
43
45
  *
44
46
  * @param VerifyUserAttributeCommandInput - {@link VerifyUserAttributeCommandInput}
@@ -95,6 +97,8 @@ export interface VerifyUserAttributeCommandOutput extends VerifyUserAttributeRes
95
97
  * @throws {@link UserNotFoundException} (client fault)
96
98
  * <p>This exception is thrown when a user isn't found.</p>
97
99
  *
100
+ * @throws {@link CognitoIdentityProviderServiceException}
101
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
98
102
  *
99
103
  */
100
104
  export declare class VerifyUserAttributeCommand extends $Command<VerifyUserAttributeCommandInput, VerifyUserAttributeCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cognito-identity-provider",
3
3
  "description": "AWS SDK for JavaScript Cognito Identity Provider Client for Node.js, Browser and React Native",
4
- "version": "3.321.1",
4
+ "version": "3.326.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,33 +21,33 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.321.1",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.321.1",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
30
- "@aws-sdk/middleware-content-length": "3.310.0",
31
- "@aws-sdk/middleware-endpoint": "3.310.0",
32
- "@aws-sdk/middleware-host-header": "3.310.0",
33
- "@aws-sdk/middleware-logger": "3.310.0",
34
- "@aws-sdk/middleware-recursion-detection": "3.310.0",
35
- "@aws-sdk/middleware-retry": "3.310.0",
36
- "@aws-sdk/middleware-serde": "3.310.0",
37
- "@aws-sdk/middleware-signing": "3.310.0",
38
- "@aws-sdk/middleware-stack": "3.310.0",
39
- "@aws-sdk/middleware-user-agent": "3.319.0",
30
+ "@aws-sdk/middleware-content-length": "3.325.0",
31
+ "@aws-sdk/middleware-endpoint": "3.325.0",
32
+ "@aws-sdk/middleware-host-header": "3.325.0",
33
+ "@aws-sdk/middleware-logger": "3.325.0",
34
+ "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.325.0",
36
+ "@aws-sdk/middleware-serde": "3.325.0",
37
+ "@aws-sdk/middleware-signing": "3.325.0",
38
+ "@aws-sdk/middleware-stack": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.325.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.316.0",
43
+ "@aws-sdk/smithy-client": "3.325.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.316.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
51
  "@aws-sdk/util-endpoints": "3.319.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",