@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 { SetUserSettingsRequest, SetUserSettingsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SetUserSettingsCommand}.
8
10
  */
9
11
  export interface SetUserSettingsCommandInput extends SetUserSettingsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SetUserSettingsCommand}.
13
17
  */
14
18
  export interface SetUserSettingsCommandOutput extends SetUserSettingsResponse, __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 SetUserSettingsCommandOutput extends SetUserSettingsResponse, _
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param SetUserSettingsCommandInput - {@link SetUserSettingsCommandInput}
37
+ * @returns {@link SetUserSettingsCommandOutput}
31
38
  * @see {@link SetUserSettingsCommandInput} for command's `input` shape.
32
39
  * @see {@link SetUserSettingsCommandOutput} for command's `response` shape.
33
40
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -63,11 +70,20 @@ export interface SetUserSettingsCommandOutput extends SetUserSettingsResponse, _
63
70
  export declare class SetUserSettingsCommand extends $Command<SetUserSettingsCommandInput, SetUserSettingsCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
64
71
  readonly input: SetUserSettingsCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: SetUserSettingsCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SetUserSettingsCommandInput, SetUserSettingsCommandOutput>;
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 { SignUpRequest, SignUpResponse } from "../models/models_1";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SignUpCommand}.
8
10
  */
9
11
  export interface SignUpCommandInput extends SignUpRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SignUpCommand}.
13
17
  */
14
18
  export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Registers the user in the specified user pool and creates a user name, password, and
18
23
  * user attributes.</p>
19
24
  *
@@ -44,6 +49,8 @@ export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {
44
49
  * const response = await client.send(command);
45
50
  * ```
46
51
  *
52
+ * @param SignUpCommandInput - {@link SignUpCommandInput}
53
+ * @returns {@link SignUpCommandOutput}
47
54
  * @see {@link SignUpCommandInput} for command's `input` shape.
48
55
  * @see {@link SignUpCommandOutput} for command's `response` shape.
49
56
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -110,11 +117,20 @@ export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {
110
117
  export declare class SignUpCommand extends $Command<SignUpCommandInput, SignUpCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
111
118
  readonly input: SignUpCommandInput;
112
119
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
120
+ /**
121
+ * @public
122
+ */
113
123
  constructor(input: SignUpCommandInput);
114
124
  /**
115
125
  * @internal
116
126
  */
117
127
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SignUpCommandInput, SignUpCommandOutput>;
128
+ /**
129
+ * @internal
130
+ */
118
131
  private serialize;
132
+ /**
133
+ * @internal
134
+ */
119
135
  private deserialize;
120
136
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { StartUserImportJobRequest, StartUserImportJobResponse } from "../models/models_1";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartUserImportJobCommand}.
8
10
  */
9
11
  export interface StartUserImportJobCommandInput extends StartUserImportJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartUserImportJobCommand}.
13
17
  */
14
18
  export interface StartUserImportJobCommandOutput extends StartUserImportJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts the user import.</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 StartUserImportJobCommandOutput extends StartUserImportJobRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param StartUserImportJobCommandInput - {@link StartUserImportJobCommandInput}
34
+ * @returns {@link StartUserImportJobCommandOutput}
28
35
  * @see {@link StartUserImportJobCommandInput} for command's `input` shape.
29
36
  * @see {@link StartUserImportJobCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -55,11 +62,20 @@ export interface StartUserImportJobCommandOutput extends StartUserImportJobRespo
55
62
  export declare class StartUserImportJobCommand extends $Command<StartUserImportJobCommandInput, StartUserImportJobCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
56
63
  readonly input: StartUserImportJobCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: StartUserImportJobCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartUserImportJobCommandInput, StartUserImportJobCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { StopUserImportJobRequest, StopUserImportJobResponse } from "../models/models_1";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StopUserImportJobCommand}.
8
10
  */
9
11
  export interface StopUserImportJobCommandInput extends StopUserImportJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StopUserImportJobCommand}.
13
17
  */
14
18
  export interface StopUserImportJobCommandOutput extends StopUserImportJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Stops the user import job.</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 StopUserImportJobCommandOutput extends StopUserImportJobRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param StopUserImportJobCommandInput - {@link StopUserImportJobCommandInput}
34
+ * @returns {@link StopUserImportJobCommandOutput}
28
35
  * @see {@link StopUserImportJobCommandInput} for command's `input` shape.
29
36
  * @see {@link StopUserImportJobCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -55,11 +62,20 @@ export interface StopUserImportJobCommandOutput extends StopUserImportJobRespons
55
62
  export declare class StopUserImportJobCommand extends $Command<StopUserImportJobCommandInput, StopUserImportJobCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
56
63
  readonly input: StopUserImportJobCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: StopUserImportJobCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopUserImportJobCommandInput, StopUserImportJobCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { TagResourceRequest, TagResourceResponse } from "../models/models_1";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to
18
23
  * categorize and manage user pools in different ways, such as by purpose, owner,
19
24
  * environment, or other criteria.</p>
@@ -38,6 +43,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
38
43
  * const response = await client.send(command);
39
44
  * ```
40
45
  *
46
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
47
+ * @returns {@link TagResourceCommandOutput}
41
48
  * @see {@link TagResourceCommandInput} for command's `input` shape.
42
49
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
43
50
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -65,11 +72,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
65
72
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
66
73
  readonly input: TagResourceCommandInput;
67
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
68
78
  constructor(input: TagResourceCommandInput);
69
79
  /**
70
80
  * @internal
71
81
  */
72
82
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
73
86
  private serialize;
87
+ /**
88
+ * @internal
89
+ */
74
90
  private deserialize;
75
91
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_1";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5
18
23
  * times per second, per account.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
35
+ * @returns {@link UntagResourceCommandOutput}
29
36
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
30
37
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
31
38
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -53,11 +60,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
53
60
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
54
61
  readonly input: UntagResourceCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: UntagResourceCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
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 { UpdateAuthEventFeedbackRequest, UpdateAuthEventFeedbackResponse } from "../models/models_1";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateAuthEventFeedbackCommand}.
8
10
  */
9
11
  export interface UpdateAuthEventFeedbackCommandInput extends UpdateAuthEventFeedbackRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateAuthEventFeedbackCommand}.
13
17
  */
14
18
  export interface UpdateAuthEventFeedbackCommandOutput extends UpdateAuthEventFeedbackResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides the feedback for an authentication event, whether it was from a valid user or
18
23
  * not. This feedback is used for improving the risk evaluation decision for the user pool
19
24
  * as part of Amazon Cognito advanced security.</p>
@@ -27,6 +32,8 @@ export interface UpdateAuthEventFeedbackCommandOutput extends UpdateAuthEventFee
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param UpdateAuthEventFeedbackCommandInput - {@link UpdateAuthEventFeedbackCommandInput}
36
+ * @returns {@link UpdateAuthEventFeedbackCommandOutput}
30
37
  * @see {@link UpdateAuthEventFeedbackCommandInput} for command's `input` shape.
31
38
  * @see {@link UpdateAuthEventFeedbackCommandOutput} for command's `response` shape.
32
39
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -60,11 +67,20 @@ export interface UpdateAuthEventFeedbackCommandOutput extends UpdateAuthEventFee
60
67
  export declare class UpdateAuthEventFeedbackCommand extends $Command<UpdateAuthEventFeedbackCommandInput, UpdateAuthEventFeedbackCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
61
68
  readonly input: UpdateAuthEventFeedbackCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: UpdateAuthEventFeedbackCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAuthEventFeedbackCommandInput, UpdateAuthEventFeedbackCommandOutput>;
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 { UpdateDeviceStatusRequest, UpdateDeviceStatusResponse } from "../models/models_1";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateDeviceStatusCommand}.
8
10
  */
9
11
  export interface UpdateDeviceStatusCommandInput extends UpdateDeviceStatusRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateDeviceStatusCommand}.
13
17
  */
14
18
  export interface UpdateDeviceStatusCommandOutput extends UpdateDeviceStatusResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the device status.</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 UpdateDeviceStatusCommandOutput extends UpdateDeviceStatusRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateDeviceStatusCommandInput - {@link UpdateDeviceStatusCommandInput}
34
+ * @returns {@link UpdateDeviceStatusCommandOutput}
28
35
  * @see {@link UpdateDeviceStatusCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateDeviceStatusCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -67,11 +74,20 @@ export interface UpdateDeviceStatusCommandOutput extends UpdateDeviceStatusRespo
67
74
  export declare class UpdateDeviceStatusCommand extends $Command<UpdateDeviceStatusCommandInput, UpdateDeviceStatusCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
68
75
  readonly input: UpdateDeviceStatusCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: UpdateDeviceStatusCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDeviceStatusCommandInput, UpdateDeviceStatusCommandOutput>;
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 { UpdateGroupRequest, UpdateGroupResponse } from "../models/models_1";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateGroupCommand}.
8
10
  */
9
11
  export interface UpdateGroupCommandInput extends UpdateGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateGroupCommand}.
13
17
  */
14
18
  export interface UpdateGroupCommandOutput extends UpdateGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the specified group with the specified attributes.</p>
18
23
  * <p>Calling this action requires developer credentials.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UpdateGroupCommandOutput extends UpdateGroupResponse, __Metadat
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UpdateGroupCommandInput - {@link UpdateGroupCommandInput}
35
+ * @returns {@link UpdateGroupCommandOutput}
29
36
  * @see {@link UpdateGroupCommandInput} for command's `input` shape.
30
37
  * @see {@link UpdateGroupCommandOutput} for command's `response` shape.
31
38
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -53,11 +60,20 @@ export interface UpdateGroupCommandOutput extends UpdateGroupResponse, __Metadat
53
60
  export declare class UpdateGroupCommand extends $Command<UpdateGroupCommandInput, UpdateGroupCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
54
61
  readonly input: UpdateGroupCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: UpdateGroupCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateGroupCommandInput, UpdateGroupCommandOutput>;
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 { UpdateIdentityProviderRequest, UpdateIdentityProviderResponse } from "../models/models_1";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateIdentityProviderCommand}.
8
10
  */
9
11
  export interface UpdateIdentityProviderCommandInput extends UpdateIdentityProviderRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateIdentityProviderCommand}.
13
17
  */
14
18
  export interface UpdateIdentityProviderCommandOutput extends UpdateIdentityProviderResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates IdP information 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 UpdateIdentityProviderCommandOutput extends UpdateIdentityProvi
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateIdentityProviderCommandInput - {@link UpdateIdentityProviderCommandInput}
34
+ * @returns {@link UpdateIdentityProviderCommandOutput}
28
35
  * @see {@link UpdateIdentityProviderCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateIdentityProviderCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -59,11 +66,20 @@ export interface UpdateIdentityProviderCommandOutput extends UpdateIdentityProvi
59
66
  export declare class UpdateIdentityProviderCommand extends $Command<UpdateIdentityProviderCommandInput, UpdateIdentityProviderCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
60
67
  readonly input: UpdateIdentityProviderCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: UpdateIdentityProviderCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateIdentityProviderCommandInput, UpdateIdentityProviderCommandOutput>;
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 { UpdateResourceServerRequest, UpdateResourceServerResponse } from "../models/models_1";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateResourceServerCommand}.
8
10
  */
9
11
  export interface UpdateResourceServerCommandInput extends UpdateResourceServerRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateResourceServerCommand}.
13
17
  */
14
18
  export interface UpdateResourceServerCommandOutput extends UpdateResourceServerResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the name and scopes of resource server. All other fields are read-only.</p>
18
23
  * <important>
19
24
  * <p>If you don't provide a value for an attribute, it is set to the default
@@ -29,6 +34,8 @@ export interface UpdateResourceServerCommandOutput extends UpdateResourceServerR
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param UpdateResourceServerCommandInput - {@link UpdateResourceServerCommandInput}
38
+ * @returns {@link UpdateResourceServerCommandOutput}
32
39
  * @see {@link UpdateResourceServerCommandInput} for command's `input` shape.
33
40
  * @see {@link UpdateResourceServerCommandOutput} for command's `response` shape.
34
41
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -56,11 +63,20 @@ export interface UpdateResourceServerCommandOutput extends UpdateResourceServerR
56
63
  export declare class UpdateResourceServerCommand extends $Command<UpdateResourceServerCommandInput, UpdateResourceServerCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
57
64
  readonly input: UpdateResourceServerCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: UpdateResourceServerCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateResourceServerCommandInput, UpdateResourceServerCommandOutput>;
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 { UpdateUserAttributesRequest, UpdateUserAttributesResponse } from "../models/models_1";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateUserAttributesCommand}.
8
10
  */
9
11
  export interface UpdateUserAttributesCommandInput extends UpdateUserAttributesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateUserAttributesCommand}.
13
17
  */
14
18
  export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Allows a user to update a specific attribute (one at a time).</p>
18
23
  *
19
24
  * <note>
@@ -43,6 +48,8 @@ export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesR
43
48
  * const response = await client.send(command);
44
49
  * ```
45
50
  *
51
+ * @param UpdateUserAttributesCommandInput - {@link UpdateUserAttributesCommandInput}
52
+ * @returns {@link UpdateUserAttributesCommandOutput}
46
53
  * @see {@link UpdateUserAttributesCommandInput} for command's `input` shape.
47
54
  * @see {@link UpdateUserAttributesCommandOutput} for command's `response` shape.
48
55
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -125,11 +132,20 @@ export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesR
125
132
  export declare class UpdateUserAttributesCommand extends $Command<UpdateUserAttributesCommandInput, UpdateUserAttributesCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
126
133
  readonly input: UpdateUserAttributesCommandInput;
127
134
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
135
+ /**
136
+ * @public
137
+ */
128
138
  constructor(input: UpdateUserAttributesCommandInput);
129
139
  /**
130
140
  * @internal
131
141
  */
132
142
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserAttributesCommandInput, UpdateUserAttributesCommandOutput>;
143
+ /**
144
+ * @internal
145
+ */
133
146
  private serialize;
147
+ /**
148
+ * @internal
149
+ */
134
150
  private deserialize;
135
151
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
5
5
  import { UpdateUserPoolClientRequest, UpdateUserPoolClientResponse } from "../models/models_1";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateUserPoolClientCommand}.
8
10
  */
9
11
  export interface UpdateUserPoolClientCommandInput extends UpdateUserPoolClientRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateUserPoolClientCommand}.
13
17
  */
14
18
  export interface UpdateUserPoolClientCommandOutput extends UpdateUserPoolClientResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the specified user pool app client with the specified attributes. You can get
18
23
  * a list of the current user pool app client settings using <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html">DescribeUserPoolClient</a>.</p>
19
24
  * <important>
@@ -32,6 +37,8 @@ export interface UpdateUserPoolClientCommandOutput extends UpdateUserPoolClientR
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param UpdateUserPoolClientCommandInput - {@link UpdateUserPoolClientCommandInput}
41
+ * @returns {@link UpdateUserPoolClientCommandOutput}
35
42
  * @see {@link UpdateUserPoolClientCommandInput} for command's `input` shape.
36
43
  * @see {@link UpdateUserPoolClientCommandOutput} for command's `response` shape.
37
44
  * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
@@ -69,11 +76,20 @@ export interface UpdateUserPoolClientCommandOutput extends UpdateUserPoolClientR
69
76
  export declare class UpdateUserPoolClientCommand extends $Command<UpdateUserPoolClientCommandInput, UpdateUserPoolClientCommandOutput, CognitoIdentityProviderClientResolvedConfig> {
70
77
  readonly input: UpdateUserPoolClientCommandInput;
71
78
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
72
82
  constructor(input: UpdateUserPoolClientCommandInput);
73
83
  /**
74
84
  * @internal
75
85
  */
76
86
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoIdentityProviderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserPoolClientCommandInput, UpdateUserPoolClientCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
77
90
  private serialize;
91
+ /**
92
+ * @internal
93
+ */
78
94
  private deserialize;
79
95
  }