@aws-sdk/client-cognito-identity-provider 3.296.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 +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminUpdateAuthEventFeedbackRequest, AdminUpdateAuthEventFeedbackResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminUpdateAuthEventFeedbackCommand}.
8
10
  */
9
11
  export interface AdminUpdateAuthEventFeedbackCommandInput extends AdminUpdateAuthEventFeedbackRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminUpdateAuthEventFeedbackCommand}.
13
17
  */
14
18
  export interface AdminUpdateAuthEventFeedbackCommandOutput extends AdminUpdateAuthEventFeedbackResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides feedback for an authentication event indicating if it was from a valid user.
18
23
  * This feedback is used for improving the risk evaluation decision for the user pool as
19
24
  * part of Amazon Cognito advanced security.</p>
@@ -27,6 +32,8 @@ export interface AdminUpdateAuthEventFeedbackCommandOutput extends AdminUpdateAu
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param AdminUpdateAuthEventFeedbackCommandInput - {@link AdminUpdateAuthEventFeedbackCommandInput}
36
+ * @returns {@link AdminUpdateAuthEventFeedbackCommandOutput}
30
37
  * @see {@link AdminUpdateAuthEventFeedbackCommandInput} for command's `input` shape.
31
38
  * @see {@link AdminUpdateAuthEventFeedbackCommandOutput} for command's `response` shape.
32
39
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -60,11 +67,20 @@ export interface AdminUpdateAuthEventFeedbackCommandOutput extends AdminUpdateAu
60
67
  export declare class AdminUpdateAuthEventFeedbackCommand extends $Command<AdminUpdateAuthEventFeedbackCommandInput, AdminUpdateAuthEventFeedbackCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
61
68
  readonly input: AdminUpdateAuthEventFeedbackCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: AdminUpdateAuthEventFeedbackCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminUpdateAuthEventFeedbackCommandInput, AdminUpdateAuthEventFeedbackCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminUpdateDeviceStatusRequest, AdminUpdateDeviceStatusResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminUpdateDeviceStatusCommand}.
8
10
  */
9
11
  export interface AdminUpdateDeviceStatusCommandInput extends AdminUpdateDeviceStatusRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminUpdateDeviceStatusCommand}.
13
17
  */
14
18
  export interface AdminUpdateDeviceStatusCommandOutput extends AdminUpdateDeviceStatusResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the device status as an administrator.</p>
18
23
  * <p>Calling this action requires developer credentials.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface AdminUpdateDeviceStatusCommandOutput extends AdminUpdateDeviceS
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param AdminUpdateDeviceStatusCommandInput - {@link AdminUpdateDeviceStatusCommandInput}
35
+ * @returns {@link AdminUpdateDeviceStatusCommandOutput}
29
36
  * @see {@link AdminUpdateDeviceStatusCommandInput} for command's `input` shape.
30
37
  * @see {@link AdminUpdateDeviceStatusCommandOutput} for command's `response` shape.
31
38
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -59,11 +66,20 @@ export interface AdminUpdateDeviceStatusCommandOutput extends AdminUpdateDeviceS
59
66
  export declare class AdminUpdateDeviceStatusCommand extends $Command<AdminUpdateDeviceStatusCommandInput, AdminUpdateDeviceStatusCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
60
67
  readonly input: AdminUpdateDeviceStatusCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: AdminUpdateDeviceStatusCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminUpdateDeviceStatusCommandInput, AdminUpdateDeviceStatusCommandOutput>;
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 { AdminUpdateUserAttributesRequest, AdminUpdateUserAttributesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminUpdateUserAttributesCommand}.
8
10
  */
9
11
  export interface AdminUpdateUserAttributesCommandInput extends AdminUpdateUserAttributesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminUpdateUserAttributesCommand}.
13
17
  */
14
18
  export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserAttributesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the specified user's attributes, including developer attributes, as an
18
23
  * administrator. Works on any user.</p>
19
24
  * <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the
@@ -50,6 +55,8 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA
50
55
  * const response = await client.send(command);
51
56
  * ```
52
57
  *
58
+ * @param AdminUpdateUserAttributesCommandInput - {@link AdminUpdateUserAttributesCommandInput}
59
+ * @returns {@link AdminUpdateUserAttributesCommandOutput}
53
60
  * @see {@link AdminUpdateUserAttributesCommandInput} for command's `input` shape.
54
61
  * @see {@link AdminUpdateUserAttributesCommandOutput} for command's `response` shape.
55
62
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -112,11 +119,20 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA
112
119
  export declare class AdminUpdateUserAttributesCommand extends $Command<AdminUpdateUserAttributesCommandInput, AdminUpdateUserAttributesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
113
120
  readonly input: AdminUpdateUserAttributesCommandInput;
114
121
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
122
+ /**
123
+ * @public
124
+ */
115
125
  constructor(input: AdminUpdateUserAttributesCommandInput);
116
126
  /**
117
127
  * @internal
118
128
  */
119
129
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminUpdateUserAttributesCommandInput, AdminUpdateUserAttributesCommandOutput>;
130
+ /**
131
+ * @internal
132
+ */
120
133
  private serialize;
134
+ /**
135
+ * @internal
136
+ */
121
137
  private deserialize;
122
138
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { AdminUserGlobalSignOutRequest, AdminUserGlobalSignOutResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AdminUserGlobalSignOutCommand}.
8
10
  */
9
11
  export interface AdminUserGlobalSignOutCommandInput extends AdminUserGlobalSignOutRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AdminUserGlobalSignOutCommand}.
13
17
  */
14
18
  export interface AdminUserGlobalSignOutCommandOutput extends AdminUserGlobalSignOutResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Signs out a user from all devices. You must sign <code>AdminUserGlobalSignOut</code> requests
18
23
  * with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to
19
24
  * a user. The user's current access and ID tokens remain valid until they expire. By
@@ -31,6 +36,8 @@ export interface AdminUserGlobalSignOutCommandOutput extends AdminUserGlobalSign
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param AdminUserGlobalSignOutCommandInput - {@link AdminUserGlobalSignOutCommandInput}
40
+ * @returns {@link AdminUserGlobalSignOutCommandOutput}
34
41
  * @see {@link AdminUserGlobalSignOutCommandInput} for command's `input` shape.
35
42
  * @see {@link AdminUserGlobalSignOutCommandOutput} for command's `response` shape.
36
43
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -61,11 +68,20 @@ export interface AdminUserGlobalSignOutCommandOutput extends AdminUserGlobalSign
61
68
  export declare class AdminUserGlobalSignOutCommand extends $Command<AdminUserGlobalSignOutCommandInput, AdminUserGlobalSignOutCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
62
69
  readonly input: AdminUserGlobalSignOutCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: AdminUserGlobalSignOutCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AdminUserGlobalSignOutCommandInput, AdminUserGlobalSignOutCommandOutput>;
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 { AssociateSoftwareTokenRequest, AssociateSoftwareTokenResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssociateSoftwareTokenCommand}.
8
10
  */
9
11
  export interface AssociateSoftwareTokenCommandInput extends AssociateSoftwareTokenRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssociateSoftwareTokenCommand}.
13
17
  */
14
18
  export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTokenResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA)
18
23
  * for a user, with a unique private key that Amazon Cognito generates and returns in the API
19
24
  * response. You can authorize an <code>AssociateSoftwareToken</code> request with either
@@ -41,6 +46,8 @@ export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTo
41
46
  * const response = await client.send(command);
42
47
  * ```
43
48
  *
49
+ * @param AssociateSoftwareTokenCommandInput - {@link AssociateSoftwareTokenCommandInput}
50
+ * @returns {@link AssociateSoftwareTokenCommandOutput}
44
51
  * @see {@link AssociateSoftwareTokenCommandInput} for command's `input` shape.
45
52
  * @see {@link AssociateSoftwareTokenCommandOutput} for command's `response` shape.
46
53
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -75,11 +82,20 @@ export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTo
75
82
  export declare class AssociateSoftwareTokenCommand extends $Command<AssociateSoftwareTokenCommandInput, AssociateSoftwareTokenCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
76
83
  readonly input: AssociateSoftwareTokenCommandInput;
77
84
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
85
+ /**
86
+ * @public
87
+ */
78
88
  constructor(input: AssociateSoftwareTokenCommandInput);
79
89
  /**
80
90
  * @internal
81
91
  */
82
92
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateSoftwareTokenCommandInput, AssociateSoftwareTokenCommandOutput>;
93
+ /**
94
+ * @internal
95
+ */
83
96
  private serialize;
97
+ /**
98
+ * @internal
99
+ */
84
100
  private deserialize;
85
101
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { ChangePasswordRequest, ChangePasswordResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ChangePasswordCommand}.
8
10
  */
9
11
  export interface ChangePasswordCommandInput extends ChangePasswordRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ChangePasswordCommand}.
13
17
  */
14
18
  export interface ChangePasswordCommandOutput extends ChangePasswordResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Changes the password for a specified user in a user pool.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ChangePasswordCommandOutput extends ChangePasswordResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ChangePasswordCommandInput - {@link ChangePasswordCommandInput}
34
+ * @returns {@link ChangePasswordCommandOutput}
28
35
  * @see {@link ChangePasswordCommandInput} for command's `input` shape.
29
36
  * @see {@link ChangePasswordCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -71,11 +78,20 @@ export interface ChangePasswordCommandOutput extends ChangePasswordResponse, __M
71
78
  export declare class ChangePasswordCommand extends $Command<ChangePasswordCommandInput, ChangePasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
72
79
  readonly input: ChangePasswordCommandInput;
73
80
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
81
+ /**
82
+ * @public
83
+ */
74
84
  constructor(input: ChangePasswordCommandInput);
75
85
  /**
76
86
  * @internal
77
87
  */
78
88
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ChangePasswordCommandInput, ChangePasswordCommandOutput>;
89
+ /**
90
+ * @internal
91
+ */
79
92
  private serialize;
93
+ /**
94
+ * @internal
95
+ */
80
96
  private deserialize;
81
97
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { ConfirmDeviceRequest, ConfirmDeviceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ConfirmDeviceCommand}.
8
10
  */
9
11
  export interface ConfirmDeviceCommandInput extends ConfirmDeviceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ConfirmDeviceCommand}.
13
17
  */
14
18
  export interface ConfirmDeviceCommandOutput extends ConfirmDeviceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Confirms tracking of the device. This API call is the call that begins device
18
23
  * tracking.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ConfirmDeviceCommandOutput extends ConfirmDeviceResponse, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ConfirmDeviceCommandInput - {@link ConfirmDeviceCommandInput}
35
+ * @returns {@link ConfirmDeviceCommandOutput}
29
36
  * @see {@link ConfirmDeviceCommandInput} for command's `input` shape.
30
37
  * @see {@link ConfirmDeviceCommandOutput} for command's `response` shape.
31
38
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -78,11 +85,20 @@ export interface ConfirmDeviceCommandOutput extends ConfirmDeviceResponse, __Met
78
85
  export declare class ConfirmDeviceCommand extends $Command<ConfirmDeviceCommandInput, ConfirmDeviceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
79
86
  readonly input: ConfirmDeviceCommandInput;
80
87
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
81
91
  constructor(input: ConfirmDeviceCommandInput);
82
92
  /**
83
93
  * @internal
84
94
  */
85
95
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ConfirmDeviceCommandInput, ConfirmDeviceCommandOutput>;
96
+ /**
97
+ * @internal
98
+ */
86
99
  private serialize;
100
+ /**
101
+ * @internal
102
+ */
87
103
  private deserialize;
88
104
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { ConfirmForgotPasswordRequest, ConfirmForgotPasswordResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ConfirmForgotPasswordCommand}.
8
10
  */
9
11
  export interface ConfirmForgotPasswordCommandInput extends ConfirmForgotPasswordRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ConfirmForgotPasswordCommand}.
13
17
  */
14
18
  export interface ConfirmForgotPasswordCommandOutput extends ConfirmForgotPasswordResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Allows a user to enter a confirmation code to reset a forgotten password.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ConfirmForgotPasswordCommandOutput extends ConfirmForgotPasswor
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ConfirmForgotPasswordCommandInput - {@link ConfirmForgotPasswordCommandInput}
34
+ * @returns {@link ConfirmForgotPasswordCommandOutput}
28
35
  * @see {@link ConfirmForgotPasswordCommandInput} for command's `input` shape.
29
36
  * @see {@link ConfirmForgotPasswordCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -90,11 +97,20 @@ export interface ConfirmForgotPasswordCommandOutput extends ConfirmForgotPasswor
90
97
  export declare class ConfirmForgotPasswordCommand extends $Command<ConfirmForgotPasswordCommandInput, ConfirmForgotPasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
91
98
  readonly input: ConfirmForgotPasswordCommandInput;
92
99
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
100
+ /**
101
+ * @public
102
+ */
93
103
  constructor(input: ConfirmForgotPasswordCommandInput);
94
104
  /**
95
105
  * @internal
96
106
  */
97
107
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ConfirmForgotPasswordCommandInput, ConfirmForgotPasswordCommandOutput>;
108
+ /**
109
+ * @internal
110
+ */
98
111
  private serialize;
112
+ /**
113
+ * @internal
114
+ */
99
115
  private deserialize;
100
116
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { ConfirmSignUpRequest, ConfirmSignUpResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ConfirmSignUpCommand}.
8
10
  */
9
11
  export interface ConfirmSignUpCommandInput extends ConfirmSignUpRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ConfirmSignUpCommand}.
13
17
  */
14
18
  export interface ConfirmSignUpCommandOutput extends ConfirmSignUpResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Confirms registration of a new user.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ConfirmSignUpCommandOutput extends ConfirmSignUpResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ConfirmSignUpCommandInput - {@link ConfirmSignUpCommandInput}
34
+ * @returns {@link ConfirmSignUpCommandOutput}
28
35
  * @see {@link ConfirmSignUpCommandInput} for command's `input` shape.
29
36
  * @see {@link ConfirmSignUpCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -91,11 +98,20 @@ export interface ConfirmSignUpCommandOutput extends ConfirmSignUpResponse, __Met
91
98
  export declare class ConfirmSignUpCommand extends $Command<ConfirmSignUpCommandInput, ConfirmSignUpCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
92
99
  readonly input: ConfirmSignUpCommandInput;
93
100
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
101
+ /**
102
+ * @public
103
+ */
94
104
  constructor(input: ConfirmSignUpCommandInput);
95
105
  /**
96
106
  * @internal
97
107
  */
98
108
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ConfirmSignUpCommandInput, ConfirmSignUpCommandOutput>;
109
+ /**
110
+ * @internal
111
+ */
99
112
  private serialize;
113
+ /**
114
+ * @internal
115
+ */
100
116
  private deserialize;
101
117
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { CreateGroupRequest, CreateGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateGroupCommand}.
8
10
  */
9
11
  export interface CreateGroupCommandInput extends CreateGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateGroupCommand}.
13
17
  */
14
18
  export interface CreateGroupCommandOutput extends CreateGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new group in the specified user pool.</p>
18
23
  * <p>Calling this action requires developer credentials.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateGroupCommandInput - {@link CreateGroupCommandInput}
35
+ * @returns {@link CreateGroupCommandOutput}
29
36
  * @see {@link CreateGroupCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateGroupCommandOutput} for command's `response` shape.
31
38
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -61,11 +68,20 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
61
68
  export declare class CreateGroupCommand extends $Command<CreateGroupCommandInput, CreateGroupCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
62
69
  readonly input: CreateGroupCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: CreateGroupCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateGroupCommandInput, CreateGroupCommandOutput>;
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 { CreateIdentityProviderRequest, CreateIdentityProviderResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateIdentityProviderCommand}.
8
10
  */
9
11
  export interface CreateIdentityProviderCommandInput extends CreateIdentityProviderRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateIdentityProviderCommand}.
13
17
  */
14
18
  export interface CreateIdentityProviderCommandOutput extends CreateIdentityProviderResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an IdP for a user pool.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateIdentityProviderCommandOutput extends CreateIdentityProvi
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateIdentityProviderCommandInput - {@link CreateIdentityProviderCommandInput}
34
+ * @returns {@link CreateIdentityProviderCommandOutput}
28
35
  * @see {@link CreateIdentityProviderCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateIdentityProviderCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -60,11 +67,20 @@ export interface CreateIdentityProviderCommandOutput extends CreateIdentityProvi
60
67
  export declare class CreateIdentityProviderCommand extends $Command<CreateIdentityProviderCommandInput, CreateIdentityProviderCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
61
68
  readonly input: CreateIdentityProviderCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: CreateIdentityProviderCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateIdentityProviderCommandInput, CreateIdentityProviderCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { CreateResourceServerRequest, CreateResourceServerResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateResourceServerCommand}.
8
10
  */
9
11
  export interface CreateResourceServerCommandInput extends CreateResourceServerRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateResourceServerCommand}.
13
17
  */
14
18
  export interface CreateResourceServerCommandOutput extends CreateResourceServerResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new OAuth2.0 resource server and defines custom scopes within it.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateResourceServerCommandOutput extends CreateResourceServerR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateResourceServerCommandInput - {@link CreateResourceServerCommandInput}
34
+ * @returns {@link CreateResourceServerCommandOutput}
28
35
  * @see {@link CreateResourceServerCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateResourceServerCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -56,11 +63,20 @@ export interface CreateResourceServerCommandOutput extends CreateResourceServerR
56
63
  export declare class CreateResourceServerCommand extends $Command<CreateResourceServerCommandInput, CreateResourceServerCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
57
64
  readonly input: CreateResourceServerCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: CreateResourceServerCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateResourceServerCommandInput, CreateResourceServerCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }