@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
@@ -55,6 +55,14 @@ export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAt
55
55
  * };
56
56
  * const command = new GetUserAttributeVerificationCodeCommand(input);
57
57
  * const response = await client.send(command);
58
+ * // { // GetUserAttributeVerificationCodeResponse
59
+ * // CodeDeliveryDetails: { // CodeDeliveryDetailsType
60
+ * // Destination: "STRING_VALUE",
61
+ * // DeliveryMedium: "SMS" || "EMAIL",
62
+ * // AttributeName: "STRING_VALUE",
63
+ * // },
64
+ * // };
65
+ *
58
66
  * ```
59
67
  *
60
68
  * @param GetUserAttributeVerificationCodeCommandInput - {@link GetUserAttributeVerificationCodeCommandInput}
@@ -126,6 +134,8 @@ export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAt
126
134
  * @throws {@link UserNotFoundException} (client fault)
127
135
  * <p>This exception is thrown when a user isn't found.</p>
128
136
  *
137
+ * @throws {@link CognitoIdentityProviderServiceException}
138
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
129
139
  *
130
140
  */
131
141
  export declare class GetUserAttributeVerificationCodeCommand extends $Command<GetUserAttributeVerificationCodeCommandInput, GetUserAttributeVerificationCodeCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -31,6 +31,26 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer
31
31
  * };
32
32
  * const command = new GetUserCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetUserResponse
35
+ * // Username: "STRING_VALUE", // required
36
+ * // UserAttributes: [ // AttributeListType // required
37
+ * // { // AttributeType
38
+ * // Name: "STRING_VALUE", // required
39
+ * // Value: "STRING_VALUE",
40
+ * // },
41
+ * // ],
42
+ * // MFAOptions: [ // MFAOptionListType
43
+ * // { // MFAOptionType
44
+ * // DeliveryMedium: "SMS" || "EMAIL",
45
+ * // AttributeName: "STRING_VALUE",
46
+ * // },
47
+ * // ],
48
+ * // PreferredMfaSetting: "STRING_VALUE",
49
+ * // UserMFASettingList: [ // UserMFASettingListType
50
+ * // "STRING_VALUE",
51
+ * // ],
52
+ * // };
53
+ *
34
54
  * ```
35
55
  *
36
56
  * @param GetUserCommandInput - {@link GetUserCommandInput}
@@ -69,6 +89,8 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer
69
89
  * @throws {@link UserNotFoundException} (client fault)
70
90
  * <p>This exception is thrown when a user isn't found.</p>
71
91
  *
92
+ * @throws {@link CognitoIdentityProviderServiceException}
93
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
72
94
  *
73
95
  */
74
96
  export declare class GetUserCommand extends $Command<GetUserCommandInput, GetUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -31,6 +31,21 @@ export interface GetUserPoolMfaConfigCommandOutput extends GetUserPoolMfaConfigR
31
31
  * };
32
32
  * const command = new GetUserPoolMfaConfigCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetUserPoolMfaConfigResponse
35
+ * // SmsMfaConfiguration: { // SmsMfaConfigType
36
+ * // SmsAuthenticationMessage: "STRING_VALUE",
37
+ * // SmsConfiguration: { // SmsConfigurationType
38
+ * // SnsCallerArn: "STRING_VALUE", // required
39
+ * // ExternalId: "STRING_VALUE",
40
+ * // SnsRegion: "STRING_VALUE",
41
+ * // },
42
+ * // },
43
+ * // SoftwareTokenMfaConfiguration: { // SoftwareTokenMfaConfigType
44
+ * // Enabled: true || false,
45
+ * // },
46
+ * // MfaConfiguration: "OFF" || "ON" || "OPTIONAL",
47
+ * // };
48
+ *
34
49
  * ```
35
50
  *
36
51
  * @param GetUserPoolMfaConfigCommandInput - {@link GetUserPoolMfaConfigCommandInput}
@@ -57,6 +72,8 @@ export interface GetUserPoolMfaConfigCommandOutput extends GetUserPoolMfaConfigR
57
72
  * <p>This exception is thrown when the user has made too many requests for a given
58
73
  * operation.</p>
59
74
  *
75
+ * @throws {@link CognitoIdentityProviderServiceException}
76
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
60
77
  *
61
78
  */
62
79
  export declare class GetUserPoolMfaConfigCommand extends $Command<GetUserPoolMfaConfigCommandInput, GetUserPoolMfaConfigCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface GlobalSignOutCommandOutput extends GlobalSignOutResponse, __Met
33
33
  * };
34
34
  * const command = new GlobalSignOutCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param GlobalSignOutCommandInput - {@link GlobalSignOutCommandInput}
@@ -68,6 +70,8 @@ export interface GlobalSignOutCommandOutput extends GlobalSignOutResponse, __Met
68
70
  * @throws {@link UserNotConfirmedException} (client fault)
69
71
  * <p>This exception is thrown when a user isn't confirmed successfully.</p>
70
72
  *
73
+ * @throws {@link CognitoIdentityProviderServiceException}
74
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
71
75
  *
72
76
  */
73
77
  export declare class GlobalSignOutCommand extends $Command<GlobalSignOutCommandInput, GlobalSignOutCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -64,6 +64,25 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad
64
64
  * };
65
65
  * const command = new InitiateAuthCommand(input);
66
66
  * const response = await client.send(command);
67
+ * // { // InitiateAuthResponse
68
+ * // 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",
69
+ * // Session: "STRING_VALUE",
70
+ * // ChallengeParameters: { // ChallengeParametersType
71
+ * // "<keys>": "STRING_VALUE",
72
+ * // },
73
+ * // AuthenticationResult: { // AuthenticationResultType
74
+ * // AccessToken: "STRING_VALUE",
75
+ * // ExpiresIn: Number("int"),
76
+ * // TokenType: "STRING_VALUE",
77
+ * // RefreshToken: "STRING_VALUE",
78
+ * // IdToken: "STRING_VALUE",
79
+ * // NewDeviceMetadata: { // NewDeviceMetadataType
80
+ * // DeviceKey: "STRING_VALUE",
81
+ * // DeviceGroupKey: "STRING_VALUE",
82
+ * // },
83
+ * // },
84
+ * // };
85
+ *
67
86
  * ```
68
87
  *
69
88
  * @param InitiateAuthCommandInput - {@link InitiateAuthCommandInput}
@@ -126,6 +145,8 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad
126
145
  * @throws {@link UserNotFoundException} (client fault)
127
146
  * <p>This exception is thrown when a user isn't found.</p>
128
147
  *
148
+ * @throws {@link CognitoIdentityProviderServiceException}
149
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
129
150
  *
130
151
  */
131
152
  export declare class InitiateAuthCommand extends $Command<InitiateAuthCommandInput, InitiateAuthCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -33,6 +33,24 @@ export interface ListDevicesCommandOutput extends ListDevicesResponse, __Metadat
33
33
  * };
34
34
  * const command = new ListDevicesCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListDevicesResponse
37
+ * // Devices: [ // DeviceListType
38
+ * // { // DeviceType
39
+ * // DeviceKey: "STRING_VALUE",
40
+ * // DeviceAttributes: [ // AttributeListType
41
+ * // { // AttributeType
42
+ * // Name: "STRING_VALUE", // required
43
+ * // Value: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // DeviceCreateDate: new Date("TIMESTAMP"),
47
+ * // DeviceLastModifiedDate: new Date("TIMESTAMP"),
48
+ * // DeviceLastAuthenticatedDate: new Date("TIMESTAMP"),
49
+ * // },
50
+ * // ],
51
+ * // PaginationToken: "STRING_VALUE",
52
+ * // };
53
+ *
36
54
  * ```
37
55
  *
38
56
  * @param ListDevicesCommandInput - {@link ListDevicesCommandInput}
@@ -74,6 +92,8 @@ export interface ListDevicesCommandOutput extends ListDevicesResponse, __Metadat
74
92
  * @throws {@link UserNotFoundException} (client fault)
75
93
  * <p>This exception is thrown when a user isn't found.</p>
76
94
  *
95
+ * @throws {@link CognitoIdentityProviderServiceException}
96
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
77
97
  *
78
98
  */
79
99
  export declare class ListDevicesCommand extends $Command<ListDevicesCommandInput, ListDevicesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -34,6 +34,21 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
34
34
  * };
35
35
  * const command = new ListGroupsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListGroupsResponse
38
+ * // Groups: [ // GroupListType
39
+ * // { // GroupType
40
+ * // GroupName: "STRING_VALUE",
41
+ * // UserPoolId: "STRING_VALUE",
42
+ * // Description: "STRING_VALUE",
43
+ * // RoleArn: "STRING_VALUE",
44
+ * // Precedence: Number("int"),
45
+ * // LastModifiedDate: new Date("TIMESTAMP"),
46
+ * // CreationDate: new Date("TIMESTAMP"),
47
+ * // },
48
+ * // ],
49
+ * // NextToken: "STRING_VALUE",
50
+ * // };
51
+ *
37
52
  * ```
38
53
  *
39
54
  * @param ListGroupsCommandInput - {@link ListGroupsCommandInput}
@@ -60,6 +75,8 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
60
75
  * <p>This exception is thrown when the user has made too many requests for a given
61
76
  * operation.</p>
62
77
  *
78
+ * @throws {@link CognitoIdentityProviderServiceException}
79
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
63
80
  *
64
81
  */
65
82
  export declare class ListGroupsCommand extends $Command<ListGroupsCommandInput, ListGroupsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -33,6 +33,18 @@ export interface ListIdentityProvidersCommandOutput extends ListIdentityProvider
33
33
  * };
34
34
  * const command = new ListIdentityProvidersCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListIdentityProvidersResponse
37
+ * // Providers: [ // ProvidersListType // required
38
+ * // { // ProviderDescription
39
+ * // ProviderName: "STRING_VALUE",
40
+ * // ProviderType: "SAML" || "Facebook" || "Google" || "LoginWithAmazon" || "SignInWithApple" || "OIDC",
41
+ * // LastModifiedDate: new Date("TIMESTAMP"),
42
+ * // CreationDate: new Date("TIMESTAMP"),
43
+ * // },
44
+ * // ],
45
+ * // NextToken: "STRING_VALUE",
46
+ * // };
47
+ *
36
48
  * ```
37
49
  *
38
50
  * @param ListIdentityProvidersCommandInput - {@link ListIdentityProvidersCommandInput}
@@ -59,6 +71,8 @@ export interface ListIdentityProvidersCommandOutput extends ListIdentityProvider
59
71
  * <p>This exception is thrown when the user has made too many requests for a given
60
72
  * operation.</p>
61
73
  *
74
+ * @throws {@link CognitoIdentityProviderServiceException}
75
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
62
76
  *
63
77
  */
64
78
  export declare class ListIdentityProvidersCommand extends $Command<ListIdentityProvidersCommandInput, ListIdentityProvidersCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -33,6 +33,23 @@ export interface ListResourceServersCommandOutput extends ListResourceServersRes
33
33
  * };
34
34
  * const command = new ListResourceServersCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListResourceServersResponse
37
+ * // ResourceServers: [ // ResourceServersListType // required
38
+ * // { // ResourceServerType
39
+ * // UserPoolId: "STRING_VALUE",
40
+ * // Identifier: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // Scopes: [ // ResourceServerScopeListType
43
+ * // { // ResourceServerScopeType
44
+ * // ScopeName: "STRING_VALUE", // required
45
+ * // ScopeDescription: "STRING_VALUE", // required
46
+ * // },
47
+ * // ],
48
+ * // },
49
+ * // ],
50
+ * // NextToken: "STRING_VALUE",
51
+ * // };
52
+ *
36
53
  * ```
37
54
  *
38
55
  * @param ListResourceServersCommandInput - {@link ListResourceServersCommandInput}
@@ -59,6 +76,8 @@ export interface ListResourceServersCommandOutput extends ListResourceServersRes
59
76
  * <p>This exception is thrown when the user has made too many requests for a given
60
77
  * operation.</p>
61
78
  *
79
+ * @throws {@link CognitoIdentityProviderServiceException}
80
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
62
81
  *
63
82
  */
64
83
  export declare class ListResourceServersCommand extends $Command<ListResourceServersCommandInput, ListResourceServersCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -34,6 +34,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
34
34
  * };
35
35
  * const command = new ListTagsForResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListTagsForResourceResponse
38
+ * // Tags: { // UserPoolTagsType
39
+ * // "<keys>": "STRING_VALUE",
40
+ * // },
41
+ * // };
42
+ *
37
43
  * ```
38
44
  *
39
45
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -60,6 +66,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
60
66
  * <p>This exception is thrown when the user has made too many requests for a given
61
67
  * operation.</p>
62
68
  *
69
+ * @throws {@link CognitoIdentityProviderServiceException}
70
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
63
71
  *
64
72
  */
65
73
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -33,6 +33,27 @@ export interface ListUserImportJobsCommandOutput extends ListUserImportJobsRespo
33
33
  * };
34
34
  * const command = new ListUserImportJobsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListUserImportJobsResponse
37
+ * // UserImportJobs: [ // UserImportJobsListType
38
+ * // { // UserImportJobType
39
+ * // JobName: "STRING_VALUE",
40
+ * // JobId: "STRING_VALUE",
41
+ * // UserPoolId: "STRING_VALUE",
42
+ * // PreSignedUrl: "STRING_VALUE",
43
+ * // CreationDate: new Date("TIMESTAMP"),
44
+ * // StartDate: new Date("TIMESTAMP"),
45
+ * // CompletionDate: new Date("TIMESTAMP"),
46
+ * // Status: "Created" || "Pending" || "InProgress" || "Stopping" || "Expired" || "Stopped" || "Failed" || "Succeeded",
47
+ * // CloudWatchLogsRoleArn: "STRING_VALUE",
48
+ * // ImportedUsers: Number("long"),
49
+ * // SkippedUsers: Number("long"),
50
+ * // FailedUsers: Number("long"),
51
+ * // CompletionMessage: "STRING_VALUE",
52
+ * // },
53
+ * // ],
54
+ * // PaginationToken: "STRING_VALUE",
55
+ * // };
56
+ *
36
57
  * ```
37
58
  *
38
59
  * @param ListUserImportJobsCommandInput - {@link ListUserImportJobsCommandInput}
@@ -59,6 +80,8 @@ export interface ListUserImportJobsCommandOutput extends ListUserImportJobsRespo
59
80
  * <p>This exception is thrown when the user has made too many requests for a given
60
81
  * operation.</p>
61
82
  *
83
+ * @throws {@link CognitoIdentityProviderServiceException}
84
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
62
85
  *
63
86
  */
64
87
  export declare class ListUserImportJobsCommand extends $Command<ListUserImportJobsCommandInput, ListUserImportJobsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -33,6 +33,17 @@ export interface ListUserPoolClientsCommandOutput extends ListUserPoolClientsRes
33
33
  * };
34
34
  * const command = new ListUserPoolClientsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListUserPoolClientsResponse
37
+ * // UserPoolClients: [ // UserPoolClientListType
38
+ * // { // UserPoolClientDescription
39
+ * // ClientId: "STRING_VALUE",
40
+ * // UserPoolId: "STRING_VALUE",
41
+ * // ClientName: "STRING_VALUE",
42
+ * // },
43
+ * // ],
44
+ * // NextToken: "STRING_VALUE",
45
+ * // };
46
+ *
36
47
  * ```
37
48
  *
38
49
  * @param ListUserPoolClientsCommandInput - {@link ListUserPoolClientsCommandInput}
@@ -59,6 +70,8 @@ export interface ListUserPoolClientsCommandOutput extends ListUserPoolClientsRes
59
70
  * <p>This exception is thrown when the user has made too many requests for a given
60
71
  * operation.</p>
61
72
  *
73
+ * @throws {@link CognitoIdentityProviderServiceException}
74
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
62
75
  *
63
76
  */
64
77
  export declare class ListUserPoolClientsCommand extends $Command<ListUserPoolClientsCommandInput, ListUserPoolClientsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -32,6 +32,40 @@ export interface ListUserPoolsCommandOutput extends ListUserPoolsResponse, __Met
32
32
  * };
33
33
  * const command = new ListUserPoolsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListUserPoolsResponse
36
+ * // UserPools: [ // UserPoolListType
37
+ * // { // UserPoolDescriptionType
38
+ * // Id: "STRING_VALUE",
39
+ * // Name: "STRING_VALUE",
40
+ * // LambdaConfig: { // LambdaConfigType
41
+ * // PreSignUp: "STRING_VALUE",
42
+ * // CustomMessage: "STRING_VALUE",
43
+ * // PostConfirmation: "STRING_VALUE",
44
+ * // PreAuthentication: "STRING_VALUE",
45
+ * // PostAuthentication: "STRING_VALUE",
46
+ * // DefineAuthChallenge: "STRING_VALUE",
47
+ * // CreateAuthChallenge: "STRING_VALUE",
48
+ * // VerifyAuthChallengeResponse: "STRING_VALUE",
49
+ * // PreTokenGeneration: "STRING_VALUE",
50
+ * // UserMigration: "STRING_VALUE",
51
+ * // CustomSMSSender: { // CustomSMSLambdaVersionConfigType
52
+ * // LambdaVersion: "V1_0", // required
53
+ * // LambdaArn: "STRING_VALUE", // required
54
+ * // },
55
+ * // CustomEmailSender: { // CustomEmailLambdaVersionConfigType
56
+ * // LambdaVersion: "V1_0", // required
57
+ * // LambdaArn: "STRING_VALUE", // required
58
+ * // },
59
+ * // KMSKeyID: "STRING_VALUE",
60
+ * // },
61
+ * // Status: "Enabled" || "Disabled",
62
+ * // LastModifiedDate: new Date("TIMESTAMP"),
63
+ * // CreationDate: new Date("TIMESTAMP"),
64
+ * // },
65
+ * // ],
66
+ * // NextToken: "STRING_VALUE",
67
+ * // };
68
+ *
35
69
  * ```
36
70
  *
37
71
  * @param ListUserPoolsCommandInput - {@link ListUserPoolsCommandInput}
@@ -54,6 +88,8 @@ export interface ListUserPoolsCommandOutput extends ListUserPoolsResponse, __Met
54
88
  * <p>This exception is thrown when the user has made too many requests for a given
55
89
  * operation.</p>
56
90
  *
91
+ * @throws {@link CognitoIdentityProviderServiceException}
92
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
57
93
  *
58
94
  */
59
95
  export declare class ListUserPoolsCommand extends $Command<ListUserPoolsCommandInput, ListUserPoolsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -37,6 +37,31 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
37
37
  * };
38
38
  * const command = new ListUsersCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // ListUsersResponse
41
+ * // Users: [ // UsersListType
42
+ * // { // UserType
43
+ * // Username: "STRING_VALUE",
44
+ * // Attributes: [ // AttributeListType
45
+ * // { // AttributeType
46
+ * // Name: "STRING_VALUE", // required
47
+ * // Value: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // UserCreateDate: new Date("TIMESTAMP"),
51
+ * // UserLastModifiedDate: new Date("TIMESTAMP"),
52
+ * // Enabled: true || false,
53
+ * // UserStatus: "UNCONFIRMED" || "CONFIRMED" || "ARCHIVED" || "COMPROMISED" || "UNKNOWN" || "RESET_REQUIRED" || "FORCE_CHANGE_PASSWORD",
54
+ * // MFAOptions: [ // MFAOptionListType
55
+ * // { // MFAOptionType
56
+ * // DeliveryMedium: "SMS" || "EMAIL",
57
+ * // AttributeName: "STRING_VALUE",
58
+ * // },
59
+ * // ],
60
+ * // },
61
+ * // ],
62
+ * // PaginationToken: "STRING_VALUE",
63
+ * // };
64
+ *
40
65
  * ```
41
66
  *
42
67
  * @param ListUsersCommandInput - {@link ListUsersCommandInput}
@@ -63,6 +88,8 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
63
88
  * <p>This exception is thrown when the user has made too many requests for a given
64
89
  * operation.</p>
65
90
  *
91
+ * @throws {@link CognitoIdentityProviderServiceException}
92
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
66
93
  *
67
94
  */
68
95
  export declare class ListUsersCommand extends $Command<ListUsersCommandInput, ListUsersCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -35,6 +35,31 @@ export interface ListUsersInGroupCommandOutput extends ListUsersInGroupResponse,
35
35
  * };
36
36
  * const command = new ListUsersInGroupCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListUsersInGroupResponse
39
+ * // Users: [ // UsersListType
40
+ * // { // UserType
41
+ * // Username: "STRING_VALUE",
42
+ * // Attributes: [ // AttributeListType
43
+ * // { // AttributeType
44
+ * // Name: "STRING_VALUE", // required
45
+ * // Value: "STRING_VALUE",
46
+ * // },
47
+ * // ],
48
+ * // UserCreateDate: new Date("TIMESTAMP"),
49
+ * // UserLastModifiedDate: new Date("TIMESTAMP"),
50
+ * // Enabled: true || false,
51
+ * // UserStatus: "UNCONFIRMED" || "CONFIRMED" || "ARCHIVED" || "COMPROMISED" || "UNKNOWN" || "RESET_REQUIRED" || "FORCE_CHANGE_PASSWORD",
52
+ * // MFAOptions: [ // MFAOptionListType
53
+ * // { // MFAOptionType
54
+ * // DeliveryMedium: "SMS" || "EMAIL",
55
+ * // AttributeName: "STRING_VALUE",
56
+ * // },
57
+ * // ],
58
+ * // },
59
+ * // ],
60
+ * // NextToken: "STRING_VALUE",
61
+ * // };
62
+ *
38
63
  * ```
39
64
  *
40
65
  * @param ListUsersInGroupCommandInput - {@link ListUsersInGroupCommandInput}
@@ -61,6 +86,8 @@ export interface ListUsersInGroupCommandOutput extends ListUsersInGroupResponse,
61
86
  * <p>This exception is thrown when the user has made too many requests for a given
62
87
  * operation.</p>
63
88
  *
89
+ * @throws {@link CognitoIdentityProviderServiceException}
90
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
64
91
  *
65
92
  */
66
93
  export declare class ListUsersInGroupCommand extends $Command<ListUsersInGroupCommandInput, ListUsersInGroupCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -62,6 +62,14 @@ export interface ResendConfirmationCodeCommandOutput extends ResendConfirmationC
62
62
  * };
63
63
  * const command = new ResendConfirmationCodeCommand(input);
64
64
  * const response = await client.send(command);
65
+ * // { // ResendConfirmationCodeResponse
66
+ * // CodeDeliveryDetails: { // CodeDeliveryDetailsType
67
+ * // Destination: "STRING_VALUE",
68
+ * // DeliveryMedium: "SMS" || "EMAIL",
69
+ * // AttributeName: "STRING_VALUE",
70
+ * // },
71
+ * // };
72
+ *
65
73
  * ```
66
74
  *
67
75
  * @param ResendConfirmationCodeCommandInput - {@link ResendConfirmationCodeCommandInput}
@@ -127,6 +135,8 @@ export interface ResendConfirmationCodeCommandOutput extends ResendConfirmationC
127
135
  * @throws {@link UserNotFoundException} (client fault)
128
136
  * <p>This exception is thrown when a user isn't found.</p>
129
137
  *
138
+ * @throws {@link CognitoIdentityProviderServiceException}
139
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
130
140
  *
131
141
  */
132
142
  export declare class ResendConfirmationCodeCommand extends $Command<ResendConfirmationCodeCommandInput, ResendConfirmationCodeCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -64,6 +64,25 @@ export interface RespondToAuthChallengeCommandOutput extends RespondToAuthChalle
64
64
  * };
65
65
  * const command = new RespondToAuthChallengeCommand(input);
66
66
  * const response = await client.send(command);
67
+ * // { // RespondToAuthChallengeResponse
68
+ * // 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",
69
+ * // Session: "STRING_VALUE",
70
+ * // ChallengeParameters: { // ChallengeParametersType
71
+ * // "<keys>": "STRING_VALUE",
72
+ * // },
73
+ * // AuthenticationResult: { // AuthenticationResultType
74
+ * // AccessToken: "STRING_VALUE",
75
+ * // ExpiresIn: Number("int"),
76
+ * // TokenType: "STRING_VALUE",
77
+ * // RefreshToken: "STRING_VALUE",
78
+ * // IdToken: "STRING_VALUE",
79
+ * // NewDeviceMetadata: { // NewDeviceMetadataType
80
+ * // DeviceKey: "STRING_VALUE",
81
+ * // DeviceGroupKey: "STRING_VALUE",
82
+ * // },
83
+ * // },
84
+ * // };
85
+ *
67
86
  * ```
68
87
  *
69
88
  * @param RespondToAuthChallengeCommandInput - {@link RespondToAuthChallengeCommandInput}
@@ -151,6 +170,8 @@ export interface RespondToAuthChallengeCommandOutput extends RespondToAuthChalle
151
170
  * @throws {@link UserNotFoundException} (client fault)
152
171
  * <p>This exception is thrown when a user isn't found.</p>
153
172
  *
173
+ * @throws {@link CognitoIdentityProviderServiceException}
174
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
154
175
  *
155
176
  */
156
177
  export declare class RespondToAuthChallengeCommand extends $Command<RespondToAuthChallengeCommandInput, RespondToAuthChallengeCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface RevokeTokenCommandOutput extends RevokeTokenResponse, __Metadat
35
35
  * };
36
36
  * const command = new RevokeTokenCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param RevokeTokenCommandInput - {@link RevokeTokenCommandInput}
@@ -68,6 +70,8 @@ export interface RevokeTokenCommandOutput extends RevokeTokenResponse, __Metadat
68
70
  * @throws {@link UnsupportedTokenTypeException} (client fault)
69
71
  * <p>Exception that is thrown when an unsupported token is passed to an operation.</p>
70
72
  *
73
+ * @throws {@link CognitoIdentityProviderServiceException}
74
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
71
75
  *
72
76
  */
73
77
  export declare class RevokeTokenCommand extends $Command<RevokeTokenCommandInput, RevokeTokenCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
@@ -88,6 +88,66 @@ export interface SetRiskConfigurationCommandOutput extends SetRiskConfigurationR
88
88
  * };
89
89
  * const command = new SetRiskConfigurationCommand(input);
90
90
  * const response = await client.send(command);
91
+ * // { // SetRiskConfigurationResponse
92
+ * // RiskConfiguration: { // RiskConfigurationType
93
+ * // UserPoolId: "STRING_VALUE",
94
+ * // ClientId: "STRING_VALUE",
95
+ * // CompromisedCredentialsRiskConfiguration: { // CompromisedCredentialsRiskConfigurationType
96
+ * // EventFilter: [ // EventFiltersType
97
+ * // "SIGN_IN" || "PASSWORD_CHANGE" || "SIGN_UP",
98
+ * // ],
99
+ * // Actions: { // CompromisedCredentialsActionsType
100
+ * // EventAction: "BLOCK" || "NO_ACTION", // required
101
+ * // },
102
+ * // },
103
+ * // AccountTakeoverRiskConfiguration: { // AccountTakeoverRiskConfigurationType
104
+ * // NotifyConfiguration: { // NotifyConfigurationType
105
+ * // From: "STRING_VALUE",
106
+ * // ReplyTo: "STRING_VALUE",
107
+ * // SourceArn: "STRING_VALUE", // required
108
+ * // BlockEmail: { // NotifyEmailType
109
+ * // Subject: "STRING_VALUE", // required
110
+ * // HtmlBody: "STRING_VALUE",
111
+ * // TextBody: "STRING_VALUE",
112
+ * // },
113
+ * // NoActionEmail: {
114
+ * // Subject: "STRING_VALUE", // required
115
+ * // HtmlBody: "STRING_VALUE",
116
+ * // TextBody: "STRING_VALUE",
117
+ * // },
118
+ * // MfaEmail: {
119
+ * // Subject: "STRING_VALUE", // required
120
+ * // HtmlBody: "STRING_VALUE",
121
+ * // TextBody: "STRING_VALUE",
122
+ * // },
123
+ * // },
124
+ * // Actions: { // AccountTakeoverActionsType
125
+ * // LowAction: { // AccountTakeoverActionType
126
+ * // Notify: true || false, // required
127
+ * // EventAction: "BLOCK" || "MFA_IF_CONFIGURED" || "MFA_REQUIRED" || "NO_ACTION", // required
128
+ * // },
129
+ * // MediumAction: {
130
+ * // Notify: true || false, // required
131
+ * // EventAction: "BLOCK" || "MFA_IF_CONFIGURED" || "MFA_REQUIRED" || "NO_ACTION", // required
132
+ * // },
133
+ * // HighAction: {
134
+ * // Notify: true || false, // required
135
+ * // EventAction: "BLOCK" || "MFA_IF_CONFIGURED" || "MFA_REQUIRED" || "NO_ACTION", // required
136
+ * // },
137
+ * // },
138
+ * // },
139
+ * // RiskExceptionConfiguration: { // RiskExceptionConfigurationType
140
+ * // BlockedIPRangeList: [ // BlockedIPRangeListType
141
+ * // "STRING_VALUE",
142
+ * // ],
143
+ * // SkippedIPRangeList: [ // SkippedIPRangeListType
144
+ * // "STRING_VALUE",
145
+ * // ],
146
+ * // },
147
+ * // LastModifiedDate: new Date("TIMESTAMP"),
148
+ * // },
149
+ * // };
150
+ *
91
151
  * ```
92
152
  *
93
153
  * @param SetRiskConfigurationCommandInput - {@link SetRiskConfigurationCommandInput}
@@ -125,6 +185,8 @@ export interface SetRiskConfigurationCommandOutput extends SetRiskConfigurationR
125
185
  * @throws {@link UserPoolAddOnNotEnabledException} (client fault)
126
186
  * <p>This exception is thrown when user pool add-ons aren't enabled.</p>
127
187
  *
188
+ * @throws {@link CognitoIdentityProviderServiceException}
189
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
128
190
  *
129
191
  */
130
192
  export declare class SetRiskConfigurationCommand extends $Command<SetRiskConfigurationCommandInput, SetRiskConfigurationCommandOutput, CognitoIdentityProviderClientResolvedConfig> {