@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 { GetSigningCertificateRequest, GetSigningCertificateResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSigningCertificateCommand}.
8
10
  */
9
11
  export interface GetSigningCertificateCommandInput extends GetSigningCertificateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSigningCertificateCommand}.
13
17
  */
14
18
  export interface GetSigningCertificateCommandOutput extends GetSigningCertificateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.</p>
18
23
  * <p>Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to <code>GetSigningCertificate</code>,
19
24
  * but doesn't invalidate the original certificate.</p>
@@ -27,6 +32,8 @@ export interface GetSigningCertificateCommandOutput extends GetSigningCertificat
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetSigningCertificateCommandInput - {@link GetSigningCertificateCommandInput}
36
+ * @returns {@link GetSigningCertificateCommandOutput}
30
37
  * @see {@link GetSigningCertificateCommandInput} for command's `input` shape.
31
38
  * @see {@link GetSigningCertificateCommandOutput} for command's `response` shape.
32
39
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -47,11 +54,20 @@ export interface GetSigningCertificateCommandOutput extends GetSigningCertificat
47
54
  export declare class GetSigningCertificateCommand extends $Command<GetSigningCertificateCommandInput, GetSigningCertificateCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
48
55
  readonly input: GetSigningCertificateCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: GetSigningCertificateCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSigningCertificateCommandInput, GetSigningCertificateCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { GetUICustomizationRequest, GetUICustomizationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetUICustomizationCommand}.
8
10
  */
9
11
  export interface GetUICustomizationCommandInput extends GetUICustomizationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetUICustomizationCommand}.
13
17
  */
14
18
  export interface GetUICustomizationCommandOutput extends GetUICustomizationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the user interface (UI) Customization information for a particular app client's
18
23
  * app UI, if any such information exists for the client. If nothing is set for the
19
24
  * particular client, but there is an existing pool level customization (the app
@@ -29,6 +34,8 @@ export interface GetUICustomizationCommandOutput extends GetUICustomizationRespo
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param GetUICustomizationCommandInput - {@link GetUICustomizationCommandInput}
38
+ * @returns {@link GetUICustomizationCommandOutput}
32
39
  * @see {@link GetUICustomizationCommandInput} for command's `input` shape.
33
40
  * @see {@link GetUICustomizationCommandOutput} for command's `response` shape.
34
41
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -56,11 +63,20 @@ export interface GetUICustomizationCommandOutput extends GetUICustomizationRespo
56
63
  export declare class GetUICustomizationCommand extends $Command<GetUICustomizationCommandInput, GetUICustomizationCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
57
64
  readonly input: GetUICustomizationCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: GetUICustomizationCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetUICustomizationCommandInput, GetUICustomizationCommandOutput>;
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 { GetUserAttributeVerificationCodeRequest, GetUserAttributeVerificationCodeResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetUserAttributeVerificationCodeCommand}.
8
10
  */
9
11
  export interface GetUserAttributeVerificationCodeCommandInput extends GetUserAttributeVerificationCodeRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetUserAttributeVerificationCodeCommand}.
13
17
  */
14
18
  export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAttributeVerificationCodeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Generates a user attribute verification code for the specified attribute name. Sends a
18
23
  * message to a user with a code that they must return in a VerifyUserAttribute
19
24
  * request.</p>
@@ -45,6 +50,8 @@ export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAt
45
50
  * const response = await client.send(command);
46
51
  * ```
47
52
  *
53
+ * @param GetUserAttributeVerificationCodeCommandInput - {@link GetUserAttributeVerificationCodeCommandInput}
54
+ * @returns {@link GetUserAttributeVerificationCodeCommandOutput}
48
55
  * @see {@link GetUserAttributeVerificationCodeCommandInput} for command's `input` shape.
49
56
  * @see {@link GetUserAttributeVerificationCodeCommandOutput} for command's `response` shape.
50
57
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -117,11 +124,20 @@ export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAt
117
124
  export declare class GetUserAttributeVerificationCodeCommand extends $Command<GetUserAttributeVerificationCodeCommandInput, GetUserAttributeVerificationCodeCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
118
125
  readonly input: GetUserAttributeVerificationCodeCommandInput;
119
126
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
127
+ /**
128
+ * @public
129
+ */
120
130
  constructor(input: GetUserAttributeVerificationCodeCommandInput);
121
131
  /**
122
132
  * @internal
123
133
  */
124
134
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetUserAttributeVerificationCodeCommandInput, GetUserAttributeVerificationCodeCommandOutput>;
135
+ /**
136
+ * @internal
137
+ */
125
138
  private serialize;
139
+ /**
140
+ * @internal
141
+ */
126
142
  private deserialize;
127
143
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { GetUserRequest, GetUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetUserCommand}.
8
10
  */
9
11
  export interface GetUserCommandInput extends GetUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetUserCommand}.
13
17
  */
14
18
  export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the user attributes and metadata for a 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 GetUserCommandOutput extends GetUserResponse, __MetadataBearer
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetUserCommandInput - {@link GetUserCommandInput}
34
+ * @returns {@link GetUserCommandOutput}
28
35
  * @see {@link GetUserCommandInput} for command's `input` shape.
29
36
  * @see {@link GetUserCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -64,11 +71,20 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer
64
71
  export declare class GetUserCommand extends $Command<GetUserCommandInput, GetUserCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
65
72
  readonly input: GetUserCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: GetUserCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetUserCommandInput, GetUserCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { GetUserPoolMfaConfigRequest, GetUserPoolMfaConfigResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetUserPoolMfaConfigCommand}.
8
10
  */
9
11
  export interface GetUserPoolMfaConfigCommandInput extends GetUserPoolMfaConfigRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetUserPoolMfaConfigCommand}.
13
17
  */
14
18
  export interface GetUserPoolMfaConfigCommandOutput extends GetUserPoolMfaConfigResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the user pool multi-factor authentication (MFA) configuration.</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 GetUserPoolMfaConfigCommandOutput extends GetUserPoolMfaConfigR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetUserPoolMfaConfigCommandInput - {@link GetUserPoolMfaConfigCommandInput}
34
+ * @returns {@link GetUserPoolMfaConfigCommandOutput}
28
35
  * @see {@link GetUserPoolMfaConfigCommandInput} for command's `input` shape.
29
36
  * @see {@link GetUserPoolMfaConfigCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -52,11 +59,20 @@ export interface GetUserPoolMfaConfigCommandOutput extends GetUserPoolMfaConfigR
52
59
  export declare class GetUserPoolMfaConfigCommand extends $Command<GetUserPoolMfaConfigCommandInput, GetUserPoolMfaConfigCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
53
60
  readonly input: GetUserPoolMfaConfigCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: GetUserPoolMfaConfigCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetUserPoolMfaConfigCommandInput, GetUserPoolMfaConfigCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { GlobalSignOutRequest, GlobalSignOutResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GlobalSignOutCommand}.
8
10
  */
9
11
  export interface GlobalSignOutCommandInput extends GlobalSignOutRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GlobalSignOutCommand}.
13
17
  */
14
18
  export interface GlobalSignOutCommandOutput extends GlobalSignOutResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito
18
23
  * has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens
19
24
  * for the duration of the 1-hour cookie validity period.</p>
@@ -27,6 +32,8 @@ export interface GlobalSignOutCommandOutput extends GlobalSignOutResponse, __Met
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GlobalSignOutCommandInput - {@link GlobalSignOutCommandInput}
36
+ * @returns {@link GlobalSignOutCommandOutput}
30
37
  * @see {@link GlobalSignOutCommandInput} for command's `input` shape.
31
38
  * @see {@link GlobalSignOutCommandOutput} for command's `response` shape.
32
39
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -63,11 +70,20 @@ export interface GlobalSignOutCommandOutput extends GlobalSignOutResponse, __Met
63
70
  export declare class GlobalSignOutCommand extends $Command<GlobalSignOutCommandInput, GlobalSignOutCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
64
71
  readonly input: GlobalSignOutCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: GlobalSignOutCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GlobalSignOutCommandInput, GlobalSignOutCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { InitiateAuthRequest, InitiateAuthResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link InitiateAuthCommand}.
8
10
  */
9
11
  export interface InitiateAuthCommandInput extends InitiateAuthRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link InitiateAuthCommand}.
13
17
  */
14
18
  export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user
18
23
  * with a federated IdP with <code>InitiateAuth</code>. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html"> Adding user pool sign-in through a third party</a>.</p>
19
24
  *
@@ -44,6 +49,8 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad
44
49
  * const response = await client.send(command);
45
50
  * ```
46
51
  *
52
+ * @param InitiateAuthCommandInput - {@link InitiateAuthCommandInput}
53
+ * @returns {@link InitiateAuthCommandOutput}
47
54
  * @see {@link InitiateAuthCommandInput} for command's `input` shape.
48
55
  * @see {@link InitiateAuthCommandOutput} for command's `response` shape.
49
56
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -107,11 +114,20 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad
107
114
  export declare class InitiateAuthCommand extends $Command<InitiateAuthCommandInput, InitiateAuthCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
108
115
  readonly input: InitiateAuthCommandInput;
109
116
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
117
+ /**
118
+ * @public
119
+ */
110
120
  constructor(input: InitiateAuthCommandInput);
111
121
  /**
112
122
  * @internal
113
123
  */
114
124
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<InitiateAuthCommandInput, InitiateAuthCommandOutput>;
125
+ /**
126
+ * @internal
127
+ */
115
128
  private serialize;
129
+ /**
130
+ * @internal
131
+ */
116
132
  private deserialize;
117
133
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { ListDevicesRequest, ListDevicesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListDevicesCommand}.
8
10
  */
9
11
  export interface ListDevicesCommandInput extends ListDevicesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListDevicesCommand}.
13
17
  */
14
18
  export interface ListDevicesCommandOutput extends ListDevicesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the sign-in devices that Amazon Cognito has registered to the current 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 ListDevicesCommandOutput extends ListDevicesResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListDevicesCommandInput - {@link ListDevicesCommandInput}
34
+ * @returns {@link ListDevicesCommandOutput}
28
35
  * @see {@link ListDevicesCommandInput} for command's `input` shape.
29
36
  * @see {@link ListDevicesCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -67,11 +74,20 @@ export interface ListDevicesCommandOutput extends ListDevicesResponse, __Metadat
67
74
  export declare class ListDevicesCommand extends $Command<ListDevicesCommandInput, ListDevicesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
68
75
  readonly input: ListDevicesCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: ListDevicesCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDevicesCommandInput, ListDevicesCommandOutput>;
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 { ListGroupsRequest, ListGroupsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListGroupsCommand}.
8
10
  */
9
11
  export interface ListGroupsCommandInput extends ListGroupsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListGroupsCommand}.
13
17
  */
14
18
  export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the groups associated with a user pool.</p>
18
23
  * <p>Calling this action requires developer credentials.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListGroupsCommandInput - {@link ListGroupsCommandInput}
35
+ * @returns {@link ListGroupsCommandOutput}
29
36
  * @see {@link ListGroupsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListGroupsCommandOutput} for command's `response` shape.
31
38
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -53,11 +60,20 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
53
60
  export declare class ListGroupsCommand extends $Command<ListGroupsCommandInput, ListGroupsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
54
61
  readonly input: ListGroupsCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: ListGroupsCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListGroupsCommandInput, ListGroupsCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { ListIdentityProvidersRequest, ListIdentityProvidersResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListIdentityProvidersCommand}.
8
10
  */
9
11
  export interface ListIdentityProvidersCommandInput extends ListIdentityProvidersRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListIdentityProvidersCommand}.
13
17
  */
14
18
  export interface ListIdentityProvidersCommandOutput extends ListIdentityProvidersResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists information about all IdPs 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 ListIdentityProvidersCommandOutput extends ListIdentityProvider
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListIdentityProvidersCommandInput - {@link ListIdentityProvidersCommandInput}
34
+ * @returns {@link ListIdentityProvidersCommandOutput}
28
35
  * @see {@link ListIdentityProvidersCommandInput} for command's `input` shape.
29
36
  * @see {@link ListIdentityProvidersCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListIdentityProvidersCommandOutput extends ListIdentityProvider
52
59
  export declare class ListIdentityProvidersCommand extends $Command<ListIdentityProvidersCommandInput, ListIdentityProvidersCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
53
60
  readonly input: ListIdentityProvidersCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: ListIdentityProvidersCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListIdentityProvidersCommandInput, ListIdentityProvidersCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { ListResourceServersRequest, ListResourceServersResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListResourceServersCommand}.
8
10
  */
9
11
  export interface ListResourceServersCommandInput extends ListResourceServersRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListResourceServersCommand}.
13
17
  */
14
18
  export interface ListResourceServersCommandOutput extends ListResourceServersResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the resource servers 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 ListResourceServersCommandOutput extends ListResourceServersRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListResourceServersCommandInput - {@link ListResourceServersCommandInput}
34
+ * @returns {@link ListResourceServersCommandOutput}
28
35
  * @see {@link ListResourceServersCommandInput} for command's `input` shape.
29
36
  * @see {@link ListResourceServersCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListResourceServersCommandOutput extends ListResourceServersRes
52
59
  export declare class ListResourceServersCommand extends $Command<ListResourceServersCommandInput, ListResourceServersCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
53
60
  readonly input: ListResourceServersCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: ListResourceServersCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListResourceServersCommandInput, ListResourceServersCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the tags that are assigned to an Amazon Cognito user pool.</p>
18
23
  * <p>A tag is a label that you can apply to user pools to categorize and manage them in
19
24
  * different ways, such as by purpose, owner, environment, or other criteria.</p>
@@ -28,6 +33,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
37
+ * @returns {@link ListTagsForResourceCommandOutput}
31
38
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
32
39
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
33
40
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -55,11 +62,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
55
62
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
56
63
  readonly input: ListTagsForResourceCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: ListTagsForResourceCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }