@aws-sdk/client-cognito-identity-provider 3.295.0 → 3.297.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 (117) hide show
  1. package/dist-types/CognitoIdentityProvider.d.ts +102 -0
  2. package/dist-types/CognitoIdentityProviderClient.d.ts +24 -4
  3. package/dist-types/commands/AddCustomAttributesCommand.d.ts +16 -0
  4. package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +16 -0
  5. package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +16 -0
  6. package/dist-types/commands/AdminCreateUserCommand.d.ts +16 -0
  7. package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +16 -0
  8. package/dist-types/commands/AdminDeleteUserCommand.d.ts +16 -0
  9. package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +16 -0
  10. package/dist-types/commands/AdminDisableUserCommand.d.ts +16 -0
  11. package/dist-types/commands/AdminEnableUserCommand.d.ts +16 -0
  12. package/dist-types/commands/AdminForgetDeviceCommand.d.ts +16 -0
  13. package/dist-types/commands/AdminGetDeviceCommand.d.ts +16 -0
  14. package/dist-types/commands/AdminGetUserCommand.d.ts +16 -0
  15. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +16 -0
  16. package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +16 -0
  17. package/dist-types/commands/AdminListDevicesCommand.d.ts +16 -0
  18. package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +16 -0
  19. package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +16 -0
  20. package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +16 -0
  21. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +16 -0
  22. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +16 -0
  23. package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +16 -0
  24. package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +16 -0
  25. package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +16 -0
  26. package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +16 -0
  27. package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +16 -0
  28. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +16 -0
  29. package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +16 -0
  30. package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +16 -0
  31. package/dist-types/commands/ChangePasswordCommand.d.ts +16 -0
  32. package/dist-types/commands/ConfirmDeviceCommand.d.ts +16 -0
  33. package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +16 -0
  34. package/dist-types/commands/ConfirmSignUpCommand.d.ts +16 -0
  35. package/dist-types/commands/CreateGroupCommand.d.ts +16 -0
  36. package/dist-types/commands/CreateIdentityProviderCommand.d.ts +16 -0
  37. package/dist-types/commands/CreateResourceServerCommand.d.ts +16 -0
  38. package/dist-types/commands/CreateUserImportJobCommand.d.ts +16 -0
  39. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +16 -0
  40. package/dist-types/commands/CreateUserPoolCommand.d.ts +16 -0
  41. package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +16 -0
  42. package/dist-types/commands/DeleteGroupCommand.d.ts +16 -0
  43. package/dist-types/commands/DeleteIdentityProviderCommand.d.ts +16 -0
  44. package/dist-types/commands/DeleteResourceServerCommand.d.ts +16 -0
  45. package/dist-types/commands/DeleteUserAttributesCommand.d.ts +16 -0
  46. package/dist-types/commands/DeleteUserCommand.d.ts +16 -0
  47. package/dist-types/commands/DeleteUserPoolClientCommand.d.ts +16 -0
  48. package/dist-types/commands/DeleteUserPoolCommand.d.ts +16 -0
  49. package/dist-types/commands/DeleteUserPoolDomainCommand.d.ts +16 -0
  50. package/dist-types/commands/DescribeIdentityProviderCommand.d.ts +16 -0
  51. package/dist-types/commands/DescribeResourceServerCommand.d.ts +16 -0
  52. package/dist-types/commands/DescribeRiskConfigurationCommand.d.ts +16 -0
  53. package/dist-types/commands/DescribeUserImportJobCommand.d.ts +16 -0
  54. package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +16 -0
  55. package/dist-types/commands/DescribeUserPoolCommand.d.ts +16 -0
  56. package/dist-types/commands/DescribeUserPoolDomainCommand.d.ts +16 -0
  57. package/dist-types/commands/ForgetDeviceCommand.d.ts +16 -0
  58. package/dist-types/commands/ForgotPasswordCommand.d.ts +16 -0
  59. package/dist-types/commands/GetCSVHeaderCommand.d.ts +16 -0
  60. package/dist-types/commands/GetDeviceCommand.d.ts +16 -0
  61. package/dist-types/commands/GetGroupCommand.d.ts +16 -0
  62. package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts +16 -0
  63. package/dist-types/commands/GetSigningCertificateCommand.d.ts +16 -0
  64. package/dist-types/commands/GetUICustomizationCommand.d.ts +16 -0
  65. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +16 -0
  66. package/dist-types/commands/GetUserCommand.d.ts +16 -0
  67. package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +16 -0
  68. package/dist-types/commands/GlobalSignOutCommand.d.ts +16 -0
  69. package/dist-types/commands/InitiateAuthCommand.d.ts +16 -0
  70. package/dist-types/commands/ListDevicesCommand.d.ts +16 -0
  71. package/dist-types/commands/ListGroupsCommand.d.ts +16 -0
  72. package/dist-types/commands/ListIdentityProvidersCommand.d.ts +16 -0
  73. package/dist-types/commands/ListResourceServersCommand.d.ts +16 -0
  74. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  75. package/dist-types/commands/ListUserImportJobsCommand.d.ts +16 -0
  76. package/dist-types/commands/ListUserPoolClientsCommand.d.ts +16 -0
  77. package/dist-types/commands/ListUserPoolsCommand.d.ts +16 -0
  78. package/dist-types/commands/ListUsersCommand.d.ts +16 -0
  79. package/dist-types/commands/ListUsersInGroupCommand.d.ts +16 -0
  80. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +16 -0
  81. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +16 -0
  82. package/dist-types/commands/RevokeTokenCommand.d.ts +16 -0
  83. package/dist-types/commands/SetRiskConfigurationCommand.d.ts +16 -0
  84. package/dist-types/commands/SetUICustomizationCommand.d.ts +16 -0
  85. package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +16 -0
  86. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +16 -0
  87. package/dist-types/commands/SetUserSettingsCommand.d.ts +16 -0
  88. package/dist-types/commands/SignUpCommand.d.ts +16 -0
  89. package/dist-types/commands/StartUserImportJobCommand.d.ts +16 -0
  90. package/dist-types/commands/StopUserImportJobCommand.d.ts +16 -0
  91. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  92. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  93. package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +16 -0
  94. package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +16 -0
  95. package/dist-types/commands/UpdateGroupCommand.d.ts +16 -0
  96. package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +16 -0
  97. package/dist-types/commands/UpdateResourceServerCommand.d.ts +16 -0
  98. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +16 -0
  99. package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +16 -0
  100. package/dist-types/commands/UpdateUserPoolCommand.d.ts +16 -0
  101. package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +16 -0
  102. package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +16 -0
  103. package/dist-types/commands/VerifyUserAttributeCommand.d.ts +16 -0
  104. package/dist-types/models/CognitoIdentityProviderServiceException.d.ts +2 -0
  105. package/dist-types/models/models_0.d.ts +507 -1
  106. package/dist-types/models/models_1.d.ts +64 -0
  107. package/dist-types/pagination/AdminListGroupsForUserPaginator.d.ts +3 -0
  108. package/dist-types/pagination/AdminListUserAuthEventsPaginator.d.ts +3 -0
  109. package/dist-types/pagination/Interfaces.d.ts +3 -0
  110. package/dist-types/pagination/ListGroupsPaginator.d.ts +3 -0
  111. package/dist-types/pagination/ListIdentityProvidersPaginator.d.ts +3 -0
  112. package/dist-types/pagination/ListResourceServersPaginator.d.ts +3 -0
  113. package/dist-types/pagination/ListUserPoolClientsPaginator.d.ts +3 -0
  114. package/dist-types/pagination/ListUserPoolsPaginator.d.ts +3 -0
  115. package/dist-types/pagination/ListUsersInGroupPaginator.d.ts +3 -0
  116. package/dist-types/pagination/ListUsersPaginator.d.ts +3 -0
  117. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminGetUserRequest, AdminGetUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminGetUserCommand}.
8
10
  */
9
11
  export interface AdminGetUserCommandInput extends AdminGetUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminGetUserCommand}.
13
17
  */
14
18
  export interface AdminGetUserCommandOutput extends AdminGetUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the specified user by user name in a user pool as an administrator. Works on any
18
23
  * user.</p>
19
24
  * <p>Calling this action requires developer credentials.</p>
@@ -27,6 +32,8 @@ export interface AdminGetUserCommandOutput extends AdminGetUserResponse, __Metad
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param AdminGetUserCommandInput - {@link AdminGetUserCommandInput}
36
+ * @returns {@link AdminGetUserCommandOutput}
30
37
  * @see {@link AdminGetUserCommandInput} for command's `input` shape.
31
38
  * @see {@link AdminGetUserCommandOutput} for command's `response` shape.
32
39
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -57,11 +64,20 @@ export interface AdminGetUserCommandOutput extends AdminGetUserResponse, __Metad
57
64
  export declare class AdminGetUserCommand extends $Command<AdminGetUserCommandInput, AdminGetUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
58
65
  readonly input: AdminGetUserCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: AdminGetUserCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminGetUserCommandInput, AdminGetUserCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminInitiateAuthRequest, AdminInitiateAuthResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminInitiateAuthCommand}.
8
10
  */
9
11
  export interface AdminInitiateAuthCommandInput extends AdminInitiateAuthRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminInitiateAuthCommand}.
13
17
  */
14
18
  export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Initiates the authentication flow, as an administrator.</p>
18
23
  *
19
24
  * <note>
@@ -45,6 +50,8 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
45
50
  * const response = await client.send(command);
46
51
  * ```
47
52
  *
53
+ * @param AdminInitiateAuthCommandInput - {@link AdminInitiateAuthCommandInput}
54
+ * @returns {@link AdminInitiateAuthCommandOutput}
48
55
  * @see {@link AdminInitiateAuthCommandInput} for command's `input` shape.
49
56
  * @see {@link AdminInitiateAuthCommandOutput} for command's `response` shape.
50
57
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -109,11 +116,20 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons
109
116
  export declare class AdminInitiateAuthCommand extends $Command<AdminInitiateAuthCommandInput, AdminInitiateAuthCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
110
117
  readonly input: AdminInitiateAuthCommandInput;
111
118
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
119
+ /**
120
+ * @public
121
+ */
112
122
  constructor(input: AdminInitiateAuthCommandInput);
113
123
  /**
114
124
  * @internal
115
125
  */
116
126
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminInitiateAuthCommandInput, AdminInitiateAuthCommandOutput>;
127
+ /**
128
+ * @internal
129
+ */
117
130
  private serialize;
131
+ /**
132
+ * @internal
133
+ */
118
134
  private deserialize;
119
135
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminLinkProviderForUserRequest, AdminLinkProviderForUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminLinkProviderForUserCommand}.
8
10
  */
9
11
  export interface AdminLinkProviderForUserCommandInput extends AdminLinkProviderForUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminLinkProviderForUserCommand}.
13
17
  */
14
18
  export interface AdminLinkProviderForUserCommandOutput extends AdminLinkProviderForUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Links an existing user account in a user pool (<code>DestinationUser</code>) to an
18
23
  * identity from an external IdP (<code>SourceUser</code>) based on a specified attribute
19
24
  * name and value from the external IdP. This allows you to create a link from the existing
@@ -43,6 +48,8 @@ export interface AdminLinkProviderForUserCommandOutput extends AdminLinkProvider
43
48
  * const response = await client.send(command);
44
49
  * ```
45
50
  *
51
+ * @param AdminLinkProviderForUserCommandInput - {@link AdminLinkProviderForUserCommandInput}
52
+ * @returns {@link AdminLinkProviderForUserCommandOutput}
46
53
  * @see {@link AdminLinkProviderForUserCommandInput} for command's `input` shape.
47
54
  * @see {@link AdminLinkProviderForUserCommandOutput} for command's `response` shape.
48
55
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -84,11 +91,20 @@ export interface AdminLinkProviderForUserCommandOutput extends AdminLinkProvider
84
91
  export declare class AdminLinkProviderForUserCommand extends $Command<AdminLinkProviderForUserCommandInput, AdminLinkProviderForUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
85
92
  readonly input: AdminLinkProviderForUserCommandInput;
86
93
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
94
+ /**
95
+ * @public
96
+ */
87
97
  constructor(input: AdminLinkProviderForUserCommandInput);
88
98
  /**
89
99
  * @internal
90
100
  */
91
101
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminLinkProviderForUserCommandInput, AdminLinkProviderForUserCommandOutput>;
102
+ /**
103
+ * @internal
104
+ */
92
105
  private serialize;
106
+ /**
107
+ * @internal
108
+ */
93
109
  private deserialize;
94
110
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminListDevicesRequest, AdminListDevicesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminListDevicesCommand}.
8
10
  */
9
11
  export interface AdminListDevicesCommandInput extends AdminListDevicesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminListDevicesCommand}.
13
17
  */
14
18
  export interface AdminListDevicesCommandOutput extends AdminListDevicesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists devices, as an administrator.</p>
18
23
  * <p>Calling this action requires developer credentials.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface AdminListDevicesCommandOutput extends AdminListDevicesResponse,
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param AdminListDevicesCommandInput - {@link AdminListDevicesCommandInput}
35
+ * @returns {@link AdminListDevicesCommandOutput}
29
36
  * @see {@link AdminListDevicesCommandInput} for command's `input` shape.
30
37
  * @see {@link AdminListDevicesCommandOutput} for command's `response` shape.
31
38
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -56,11 +63,20 @@ export interface AdminListDevicesCommandOutput extends AdminListDevicesResponse,
56
63
  export declare class AdminListDevicesCommand extends $Command<AdminListDevicesCommandInput, AdminListDevicesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
57
64
  readonly input: AdminListDevicesCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: AdminListDevicesCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminListDevicesCommandInput, AdminListDevicesCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminListGroupsForUserRequest, AdminListGroupsForUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminListGroupsForUserCommand}.
8
10
  */
9
11
  export interface AdminListGroupsForUserCommandInput extends AdminListGroupsForUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminListGroupsForUserCommand}.
13
17
  */
14
18
  export interface AdminListGroupsForUserCommandOutput extends AdminListGroupsForUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the groups that the user belongs to.</p>
18
23
  * <p>Calling this action requires developer credentials.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface AdminListGroupsForUserCommandOutput extends AdminListGroupsForU
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param AdminListGroupsForUserCommandInput - {@link AdminListGroupsForUserCommandInput}
35
+ * @returns {@link AdminListGroupsForUserCommandOutput}
29
36
  * @see {@link AdminListGroupsForUserCommandInput} for command's `input` shape.
30
37
  * @see {@link AdminListGroupsForUserCommandOutput} for command's `response` shape.
31
38
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -56,11 +63,20 @@ export interface AdminListGroupsForUserCommandOutput extends AdminListGroupsForU
56
63
  export declare class AdminListGroupsForUserCommand extends $Command<AdminListGroupsForUserCommandInput, AdminListGroupsForUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
57
64
  readonly input: AdminListGroupsForUserCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: AdminListGroupsForUserCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminListGroupsForUserCommandInput, AdminListGroupsForUserCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminListUserAuthEventsRequest, AdminListUserAuthEventsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminListUserAuthEventsCommand}.
8
10
  */
9
11
  export interface AdminListUserAuthEventsCommandInput extends AdminListUserAuthEventsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminListUserAuthEventsCommand}.
13
17
  */
14
18
  export interface AdminListUserAuthEventsCommandOutput extends AdminListUserAuthEventsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>A history of user activity and any risks detected as part of Amazon Cognito advanced
18
23
  * security.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface AdminListUserAuthEventsCommandOutput extends AdminListUserAuthE
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param AdminListUserAuthEventsCommandInput - {@link AdminListUserAuthEventsCommandInput}
35
+ * @returns {@link AdminListUserAuthEventsCommandOutput}
29
36
  * @see {@link AdminListUserAuthEventsCommandInput} for command's `input` shape.
30
37
  * @see {@link AdminListUserAuthEventsCommandOutput} for command's `response` shape.
31
38
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -59,11 +66,20 @@ export interface AdminListUserAuthEventsCommandOutput extends AdminListUserAuthE
59
66
  export declare class AdminListUserAuthEventsCommand extends $Command<AdminListUserAuthEventsCommandInput, AdminListUserAuthEventsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
60
67
  readonly input: AdminListUserAuthEventsCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: AdminListUserAuthEventsCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminListUserAuthEventsCommandInput, AdminListUserAuthEventsCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminRemoveUserFromGroupRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminRemoveUserFromGroupCommand}.
8
10
  */
9
11
  export interface AdminRemoveUserFromGroupCommandInput extends AdminRemoveUserFromGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminRemoveUserFromGroupCommand}.
13
17
  */
14
18
  export interface AdminRemoveUserFromGroupCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the specified user from the specified group.</p>
18
23
  * <p>Calling this action requires developer credentials.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface AdminRemoveUserFromGroupCommandOutput extends __MetadataBearer
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param AdminRemoveUserFromGroupCommandInput - {@link AdminRemoveUserFromGroupCommandInput}
35
+ * @returns {@link AdminRemoveUserFromGroupCommandOutput}
29
36
  * @see {@link AdminRemoveUserFromGroupCommandInput} for command's `input` shape.
30
37
  * @see {@link AdminRemoveUserFromGroupCommandOutput} for command's `response` shape.
31
38
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -56,11 +63,20 @@ export interface AdminRemoveUserFromGroupCommandOutput extends __MetadataBearer
56
63
  export declare class AdminRemoveUserFromGroupCommand extends $Command<AdminRemoveUserFromGroupCommandInput, AdminRemoveUserFromGroupCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
57
64
  readonly input: AdminRemoveUserFromGroupCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: AdminRemoveUserFromGroupCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminRemoveUserFromGroupCommandInput, AdminRemoveUserFromGroupCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminResetUserPasswordRequest, AdminResetUserPasswordResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminResetUserPasswordCommand}.
8
10
  */
9
11
  export interface AdminResetUserPasswordCommandInput extends AdminResetUserPasswordRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminResetUserPasswordCommand}.
13
17
  */
14
18
  export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPasswordResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Resets the specified user's password in a user pool as an administrator. Works on any
18
23
  * user.</p>
19
24
  * <p>When a developer calls this API, the current password is invalidated, so it must be
@@ -54,6 +59,8 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
54
59
  * const response = await client.send(command);
55
60
  * ```
56
61
  *
62
+ * @param AdminResetUserPasswordCommandInput - {@link AdminResetUserPasswordCommandInput}
63
+ * @returns {@link AdminResetUserPasswordCommandOutput}
57
64
  * @see {@link AdminResetUserPasswordCommandInput} for command's `input` shape.
58
65
  * @see {@link AdminResetUserPasswordCommandOutput} for command's `response` shape.
59
66
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -113,11 +120,20 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw
113
120
  export declare class AdminResetUserPasswordCommand extends $Command<AdminResetUserPasswordCommandInput, AdminResetUserPasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
114
121
  readonly input: AdminResetUserPasswordCommandInput;
115
122
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
123
+ /**
124
+ * @public
125
+ */
116
126
  constructor(input: AdminResetUserPasswordCommandInput);
117
127
  /**
118
128
  * @internal
119
129
  */
120
130
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminResetUserPasswordCommandInput, AdminResetUserPasswordCommandOutput>;
131
+ /**
132
+ * @internal
133
+ */
121
134
  private serialize;
135
+ /**
136
+ * @internal
137
+ */
122
138
  private deserialize;
123
139
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminRespondToAuthChallengeRequest, AdminRespondToAuthChallengeResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminRespondToAuthChallengeCommand}.
8
10
  */
9
11
  export interface AdminRespondToAuthChallengeCommandInput extends AdminRespondToAuthChallengeRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminRespondToAuthChallengeCommand}.
13
17
  */
14
18
  export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondToAuthChallengeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Responds to an authentication challenge, as an administrator.</p>
18
23
  *
19
24
  * <note>
@@ -45,6 +50,8 @@ export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondTo
45
50
  * const response = await client.send(command);
46
51
  * ```
47
52
  *
53
+ * @param AdminRespondToAuthChallengeCommandInput - {@link AdminRespondToAuthChallengeCommandInput}
54
+ * @returns {@link AdminRespondToAuthChallengeCommandOutput}
48
55
  * @see {@link AdminRespondToAuthChallengeCommandInput} for command's `input` shape.
49
56
  * @see {@link AdminRespondToAuthChallengeCommandOutput} for command's `response` shape.
50
57
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -130,11 +137,20 @@ export interface AdminRespondToAuthChallengeCommandOutput extends AdminRespondTo
130
137
  export declare class AdminRespondToAuthChallengeCommand extends $Command<AdminRespondToAuthChallengeCommandInput, AdminRespondToAuthChallengeCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
131
138
  readonly input: AdminRespondToAuthChallengeCommandInput;
132
139
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
140
+ /**
141
+ * @public
142
+ */
133
143
  constructor(input: AdminRespondToAuthChallengeCommandInput);
134
144
  /**
135
145
  * @internal
136
146
  */
137
147
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminRespondToAuthChallengeCommandInput, AdminRespondToAuthChallengeCommandOutput>;
148
+ /**
149
+ * @internal
150
+ */
138
151
  private serialize;
152
+ /**
153
+ * @internal
154
+ */
139
155
  private deserialize;
140
156
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminSetUserMFAPreferenceRequest, AdminSetUserMFAPreferenceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminSetUserMFAPreferenceCommand}.
8
10
  */
9
11
  export interface AdminSetUserMFAPreferenceCommandInput extends AdminSetUserMFAPreferenceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminSetUserMFAPreferenceCommand}.
13
17
  */
14
18
  export interface AdminSetUserMFAPreferenceCommandOutput extends AdminSetUserMFAPreferenceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>The user's multi-factor authentication (MFA) preference, including which MFA options
18
23
  * are activated, and if any are preferred. Only one factor can be set as preferred. The
19
24
  * preferred MFA factor will be used to authenticate a user if multiple factors are
@@ -29,6 +34,8 @@ export interface AdminSetUserMFAPreferenceCommandOutput extends AdminSetUserMFAP
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param AdminSetUserMFAPreferenceCommandInput - {@link AdminSetUserMFAPreferenceCommandInput}
38
+ * @returns {@link AdminSetUserMFAPreferenceCommandOutput}
32
39
  * @see {@link AdminSetUserMFAPreferenceCommandInput} for command's `input` shape.
33
40
  * @see {@link AdminSetUserMFAPreferenceCommandOutput} for command's `response` shape.
34
41
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -61,11 +68,20 @@ export interface AdminSetUserMFAPreferenceCommandOutput extends AdminSetUserMFAP
61
68
  export declare class AdminSetUserMFAPreferenceCommand extends $Command<AdminSetUserMFAPreferenceCommandInput, AdminSetUserMFAPreferenceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
62
69
  readonly input: AdminSetUserMFAPreferenceCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: AdminSetUserMFAPreferenceCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminSetUserMFAPreferenceCommandInput, AdminSetUserMFAPreferenceCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminSetUserPasswordRequest, AdminSetUserPasswordResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminSetUserPasswordCommand}.
8
10
  */
9
11
  export interface AdminSetUserPasswordCommandInput extends AdminSetUserPasswordRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminSetUserPasswordCommand}.
13
17
  */
14
18
  export interface AdminSetUserPasswordCommandOutput extends AdminSetUserPasswordResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sets the specified user's password in a user pool as an administrator. Works on any
18
23
  * user. </p>
19
24
  * <p>The password can be temporary or permanent. If it is temporary, the user status enters
@@ -34,6 +39,8 @@ export interface AdminSetUserPasswordCommandOutput extends AdminSetUserPasswordR
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param AdminSetUserPasswordCommandInput - {@link AdminSetUserPasswordCommandInput}
43
+ * @returns {@link AdminSetUserPasswordCommandOutput}
37
44
  * @see {@link AdminSetUserPasswordCommandInput} for command's `input` shape.
38
45
  * @see {@link AdminSetUserPasswordCommandOutput} for command's `response` shape.
39
46
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -67,11 +74,20 @@ export interface AdminSetUserPasswordCommandOutput extends AdminSetUserPasswordR
67
74
  export declare class AdminSetUserPasswordCommand extends $Command<AdminSetUserPasswordCommandInput, AdminSetUserPasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
68
75
  readonly input: AdminSetUserPasswordCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: AdminSetUserPasswordCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminSetUserPasswordCommandInput, AdminSetUserPasswordCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminSetUserSettingsRequest, AdminSetUserSettingsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminSetUserSettingsCommand}.
8
10
  */
9
11
  export interface AdminSetUserSettingsCommandInput extends AdminSetUserSettingsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminSetUserSettingsCommand}.
13
17
  */
14
18
  export interface AdminSetUserSettingsCommandOutput extends AdminSetUserSettingsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>
18
23
  * <i>This action is no longer supported.</i> You can use it to configure
19
24
  * only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software
@@ -28,6 +33,8 @@ export interface AdminSetUserSettingsCommandOutput extends AdminSetUserSettingsR
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param AdminSetUserSettingsCommandInput - {@link AdminSetUserSettingsCommandInput}
37
+ * @returns {@link AdminSetUserSettingsCommandOutput}
31
38
  * @see {@link AdminSetUserSettingsCommandInput} for command's `input` shape.
32
39
  * @see {@link AdminSetUserSettingsCommandOutput} for command's `response` shape.
33
40
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -54,11 +61,20 @@ export interface AdminSetUserSettingsCommandOutput extends AdminSetUserSettingsR
54
61
  export declare class AdminSetUserSettingsCommand extends $Command<AdminSetUserSettingsCommandInput, AdminSetUserSettingsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
55
62
  readonly input: AdminSetUserSettingsCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: AdminSetUserSettingsCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminSetUserSettingsCommandInput, AdminSetUserSettingsCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }