@aws-sdk/client-cognito-identity-provider 3.865.0 → 3.873.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.
- package/README.md +40 -0
- package/dist-cjs/index.js +361 -58
- package/dist-es/CognitoIdentityProvider.js +10 -0
- package/dist-es/commands/CreateTermsCommand.js +23 -0
- package/dist-es/commands/DeleteTermsCommand.js +22 -0
- package/dist-es/commands/DescribeTermsCommand.js +23 -0
- package/dist-es/commands/GetTokensFromRefreshTokenCommand.js +2 -1
- package/dist-es/commands/GetUICustomizationCommand.js +1 -1
- package/dist-es/commands/GetUserAttributeVerificationCodeCommand.js +1 -1
- package/dist-es/commands/GetUserCommand.js +1 -1
- package/dist-es/commands/ListTermsCommand.js +22 -0
- package/dist-es/commands/UpdateTermsCommand.js +23 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +34 -45
- package/dist-es/models/models_1.js +50 -1
- package/dist-es/protocols/Aws_json1_1.js +157 -2
- package/dist-types/CognitoIdentityProvider.d.ts +35 -0
- package/dist-types/CognitoIdentityProviderClient.d.ts +7 -2
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +6 -2
- package/dist-types/commands/CreateManagedLoginBrandingCommand.d.ts +1 -1
- package/dist-types/commands/CreateTermsCommand.d.ts +151 -0
- package/dist-types/commands/DeleteTermsCommand.d.ts +113 -0
- package/dist-types/commands/DescribeTermsCommand.d.ts +123 -0
- package/dist-types/commands/ForgotPasswordCommand.d.ts +6 -3
- package/dist-types/commands/GetTokensFromRefreshTokenCommand.d.ts +2 -1
- package/dist-types/commands/GetUICustomizationCommand.d.ts +1 -1
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +1 -1
- package/dist-types/commands/GetUserCommand.d.ts +1 -1
- package/dist-types/commands/ListTermsCommand.d.ts +121 -0
- package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +1 -1
- package/dist-types/commands/UpdateManagedLoginBrandingCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTermsCommand.d.ts +147 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +485 -366
- package/dist-types/models/models_1.d.ts +600 -119
- package/dist-types/protocols/Aws_json1_1.d.ts +45 -0
- package/dist-types/ts3.4/CognitoIdentityProvider.d.ts +85 -0
- package/dist-types/ts3.4/CognitoIdentityProviderClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateTermsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteTermsCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/DescribeTermsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetTokensFromRefreshTokenCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/GetUICustomizationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetUserAttributeVerificationCodeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTermsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateTermsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +60 -65
- package/dist-types/ts3.4/models/models_1.d.ts +98 -1
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +60 -0
- package/package.json +11 -11
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
+
import { CreateTermsRequest, CreateTermsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateTermsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateTermsCommandInput extends CreateTermsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateTermsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateTermsCommandOutput extends CreateTermsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateTermsCommand_base: {
|
|
25
|
+
new (input: CreateTermsCommandInput): import("@smithy/smithy-client").CommandImpl<CreateTermsCommandInput, CreateTermsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CreateTermsCommandInput): import("@smithy/smithy-client").CommandImpl<CreateTermsCommandInput, CreateTermsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates terms documents for the requested app client. When Terms and conditions and
|
|
31
|
+
* Privacy policy documents are configured, the app client displays links to them in the
|
|
32
|
+
* sign-up page of managed login for the app client.</p>
|
|
33
|
+
* <p>You can provide URLs for terms documents in the languages that are supported by <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-localization">managed login localization</a>. Amazon Cognito directs users to the terms documents for
|
|
34
|
+
* their current language, with fallback to <code>default</code> if no document exists for
|
|
35
|
+
* the language.</p>
|
|
36
|
+
* <p>Each request accepts one type of terms document and a map of language-to-link for that
|
|
37
|
+
* document type. You must provide both types of terms documents in at least one language
|
|
38
|
+
* before Amazon Cognito displays your terms documents. Supply each type in separate
|
|
39
|
+
* requests.</p>
|
|
40
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-terms-documents">Terms documents</a>.</p>
|
|
41
|
+
* <note>
|
|
42
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
43
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
44
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
45
|
+
* <p class="title">
|
|
46
|
+
* <b>Learn more</b>
|
|
47
|
+
* </p>
|
|
48
|
+
* <ul>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>
|
|
51
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
52
|
+
* </p>
|
|
53
|
+
* </li>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>
|
|
56
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
|
|
57
|
+
* </p>
|
|
58
|
+
* </li>
|
|
59
|
+
* </ul>
|
|
60
|
+
* </note>
|
|
61
|
+
* @example
|
|
62
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
63
|
+
* ```javascript
|
|
64
|
+
* import { CognitoIdentityProviderClient, CreateTermsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
|
|
65
|
+
* // const { CognitoIdentityProviderClient, CreateTermsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
|
|
66
|
+
* const client = new CognitoIdentityProviderClient(config);
|
|
67
|
+
* const input = { // CreateTermsRequest
|
|
68
|
+
* UserPoolId: "STRING_VALUE", // required
|
|
69
|
+
* ClientId: "STRING_VALUE", // required
|
|
70
|
+
* TermsName: "STRING_VALUE", // required
|
|
71
|
+
* TermsSource: "LINK", // required
|
|
72
|
+
* Enforcement: "NONE", // required
|
|
73
|
+
* Links: { // LinksType
|
|
74
|
+
* "<keys>": "STRING_VALUE",
|
|
75
|
+
* },
|
|
76
|
+
* };
|
|
77
|
+
* const command = new CreateTermsCommand(input);
|
|
78
|
+
* const response = await client.send(command);
|
|
79
|
+
* // { // CreateTermsResponse
|
|
80
|
+
* // Terms: { // TermsType
|
|
81
|
+
* // TermsId: "STRING_VALUE", // required
|
|
82
|
+
* // UserPoolId: "STRING_VALUE", // required
|
|
83
|
+
* // ClientId: "STRING_VALUE", // required
|
|
84
|
+
* // TermsName: "STRING_VALUE", // required
|
|
85
|
+
* // TermsSource: "LINK", // required
|
|
86
|
+
* // Enforcement: "NONE", // required
|
|
87
|
+
* // Links: { // LinksType // required
|
|
88
|
+
* // "<keys>": "STRING_VALUE",
|
|
89
|
+
* // },
|
|
90
|
+
* // CreationDate: new Date("TIMESTAMP"), // required
|
|
91
|
+
* // LastModifiedDate: new Date("TIMESTAMP"), // required
|
|
92
|
+
* // },
|
|
93
|
+
* // };
|
|
94
|
+
*
|
|
95
|
+
* ```
|
|
96
|
+
*
|
|
97
|
+
* @param CreateTermsCommandInput - {@link CreateTermsCommandInput}
|
|
98
|
+
* @returns {@link CreateTermsCommandOutput}
|
|
99
|
+
* @see {@link CreateTermsCommandInput} for command's `input` shape.
|
|
100
|
+
* @see {@link CreateTermsCommandOutput} for command's `response` shape.
|
|
101
|
+
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link ConcurrentModificationException} (client fault)
|
|
104
|
+
* <p>This exception is thrown if two or more modifications are happening
|
|
105
|
+
* concurrently.</p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link InternalErrorException} (server fault)
|
|
108
|
+
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
111
|
+
* <p>This exception is thrown when the Amazon Cognito service encounters an invalid
|
|
112
|
+
* parameter.</p>
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
115
|
+
* <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
|
|
116
|
+
* resource.</p>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link NotAuthorizedException} (client fault)
|
|
119
|
+
* <p>This exception is thrown when a user isn't authorized.</p>
|
|
120
|
+
*
|
|
121
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
122
|
+
* <p>This exception is thrown when the Amazon Cognito service can't find the requested
|
|
123
|
+
* resource.</p>
|
|
124
|
+
*
|
|
125
|
+
* @throws {@link TermsExistsException} (client fault)
|
|
126
|
+
* <p>Terms document names must be unique to the app client. This exception is thrown when
|
|
127
|
+
* you attempt to create terms documents with a duplicate <code>TermsName</code>.</p>
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
130
|
+
* <p>This exception is thrown when the user has made too many requests for a given
|
|
131
|
+
* operation.</p>
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link CognitoIdentityProviderServiceException}
|
|
134
|
+
* <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
|
|
135
|
+
*
|
|
136
|
+
*
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
export declare class CreateTermsCommand extends CreateTermsCommand_base {
|
|
140
|
+
/** @internal type navigation helper, not in runtime. */
|
|
141
|
+
protected static __types: {
|
|
142
|
+
api: {
|
|
143
|
+
input: CreateTermsRequest;
|
|
144
|
+
output: CreateTermsResponse;
|
|
145
|
+
};
|
|
146
|
+
sdk: {
|
|
147
|
+
input: CreateTermsCommandInput;
|
|
148
|
+
output: CreateTermsCommandOutput;
|
|
149
|
+
};
|
|
150
|
+
};
|
|
151
|
+
}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
+
import { DeleteTermsRequest } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteTermsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteTermsCommandInput extends DeleteTermsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteTermsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteTermsCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteTermsCommand_base: {
|
|
25
|
+
new (input: DeleteTermsCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteTermsCommandInput, DeleteTermsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteTermsCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteTermsCommandInput, DeleteTermsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes the terms documents with the requested ID from your app client.</p>
|
|
31
|
+
* <note>
|
|
32
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
34
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
35
|
+
* <p class="title">
|
|
36
|
+
* <b>Learn more</b>
|
|
37
|
+
* </p>
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>
|
|
41
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
42
|
+
* </p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>
|
|
46
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
|
|
47
|
+
* </p>
|
|
48
|
+
* </li>
|
|
49
|
+
* </ul>
|
|
50
|
+
* </note>
|
|
51
|
+
* @example
|
|
52
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
53
|
+
* ```javascript
|
|
54
|
+
* import { CognitoIdentityProviderClient, DeleteTermsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
|
|
55
|
+
* // const { CognitoIdentityProviderClient, DeleteTermsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
|
|
56
|
+
* const client = new CognitoIdentityProviderClient(config);
|
|
57
|
+
* const input = { // DeleteTermsRequest
|
|
58
|
+
* TermsId: "STRING_VALUE", // required
|
|
59
|
+
* UserPoolId: "STRING_VALUE", // required
|
|
60
|
+
* };
|
|
61
|
+
* const command = new DeleteTermsCommand(input);
|
|
62
|
+
* const response = await client.send(command);
|
|
63
|
+
* // {};
|
|
64
|
+
*
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
67
|
+
* @param DeleteTermsCommandInput - {@link DeleteTermsCommandInput}
|
|
68
|
+
* @returns {@link DeleteTermsCommandOutput}
|
|
69
|
+
* @see {@link DeleteTermsCommandInput} for command's `input` shape.
|
|
70
|
+
* @see {@link DeleteTermsCommandOutput} for command's `response` shape.
|
|
71
|
+
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ConcurrentModificationException} (client fault)
|
|
74
|
+
* <p>This exception is thrown if two or more modifications are happening
|
|
75
|
+
* concurrently.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link InternalErrorException} (server fault)
|
|
78
|
+
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
81
|
+
* <p>This exception is thrown when the Amazon Cognito service encounters an invalid
|
|
82
|
+
* parameter.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link NotAuthorizedException} (client fault)
|
|
85
|
+
* <p>This exception is thrown when a user isn't authorized.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
88
|
+
* <p>This exception is thrown when the Amazon Cognito service can't find the requested
|
|
89
|
+
* resource.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
92
|
+
* <p>This exception is thrown when the user has made too many requests for a given
|
|
93
|
+
* operation.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link CognitoIdentityProviderServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
|
|
97
|
+
*
|
|
98
|
+
*
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
export declare class DeleteTermsCommand extends DeleteTermsCommand_base {
|
|
102
|
+
/** @internal type navigation helper, not in runtime. */
|
|
103
|
+
protected static __types: {
|
|
104
|
+
api: {
|
|
105
|
+
input: DeleteTermsRequest;
|
|
106
|
+
output: {};
|
|
107
|
+
};
|
|
108
|
+
sdk: {
|
|
109
|
+
input: DeleteTermsCommandInput;
|
|
110
|
+
output: DeleteTermsCommandOutput;
|
|
111
|
+
};
|
|
112
|
+
};
|
|
113
|
+
}
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
+
import { DescribeTermsRequest, DescribeTermsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeTermsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeTermsCommandInput extends DescribeTermsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeTermsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeTermsCommandOutput extends DescribeTermsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeTermsCommand_base: {
|
|
25
|
+
new (input: DescribeTermsCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeTermsCommandInput, DescribeTermsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DescribeTermsCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeTermsCommandInput, DescribeTermsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns details for the requested terms documents ID. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-terms-documents">Terms documents</a>.</p>
|
|
31
|
+
* <note>
|
|
32
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
34
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
35
|
+
* <p class="title">
|
|
36
|
+
* <b>Learn more</b>
|
|
37
|
+
* </p>
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>
|
|
41
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
42
|
+
* </p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>
|
|
46
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
|
|
47
|
+
* </p>
|
|
48
|
+
* </li>
|
|
49
|
+
* </ul>
|
|
50
|
+
* </note>
|
|
51
|
+
* @example
|
|
52
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
53
|
+
* ```javascript
|
|
54
|
+
* import { CognitoIdentityProviderClient, DescribeTermsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
|
|
55
|
+
* // const { CognitoIdentityProviderClient, DescribeTermsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
|
|
56
|
+
* const client = new CognitoIdentityProviderClient(config);
|
|
57
|
+
* const input = { // DescribeTermsRequest
|
|
58
|
+
* TermsId: "STRING_VALUE", // required
|
|
59
|
+
* UserPoolId: "STRING_VALUE", // required
|
|
60
|
+
* };
|
|
61
|
+
* const command = new DescribeTermsCommand(input);
|
|
62
|
+
* const response = await client.send(command);
|
|
63
|
+
* // { // DescribeTermsResponse
|
|
64
|
+
* // Terms: { // TermsType
|
|
65
|
+
* // TermsId: "STRING_VALUE", // required
|
|
66
|
+
* // UserPoolId: "STRING_VALUE", // required
|
|
67
|
+
* // ClientId: "STRING_VALUE", // required
|
|
68
|
+
* // TermsName: "STRING_VALUE", // required
|
|
69
|
+
* // TermsSource: "LINK", // required
|
|
70
|
+
* // Enforcement: "NONE", // required
|
|
71
|
+
* // Links: { // LinksType // required
|
|
72
|
+
* // "<keys>": "STRING_VALUE",
|
|
73
|
+
* // },
|
|
74
|
+
* // CreationDate: new Date("TIMESTAMP"), // required
|
|
75
|
+
* // LastModifiedDate: new Date("TIMESTAMP"), // required
|
|
76
|
+
* // },
|
|
77
|
+
* // };
|
|
78
|
+
*
|
|
79
|
+
* ```
|
|
80
|
+
*
|
|
81
|
+
* @param DescribeTermsCommandInput - {@link DescribeTermsCommandInput}
|
|
82
|
+
* @returns {@link DescribeTermsCommandOutput}
|
|
83
|
+
* @see {@link DescribeTermsCommandInput} for command's `input` shape.
|
|
84
|
+
* @see {@link DescribeTermsCommandOutput} for command's `response` shape.
|
|
85
|
+
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link InternalErrorException} (server fault)
|
|
88
|
+
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
91
|
+
* <p>This exception is thrown when the Amazon Cognito service encounters an invalid
|
|
92
|
+
* parameter.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link NotAuthorizedException} (client fault)
|
|
95
|
+
* <p>This exception is thrown when a user isn't authorized.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
98
|
+
* <p>This exception is thrown when the Amazon Cognito service can't find the requested
|
|
99
|
+
* resource.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
102
|
+
* <p>This exception is thrown when the user has made too many requests for a given
|
|
103
|
+
* operation.</p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link CognitoIdentityProviderServiceException}
|
|
106
|
+
* <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
|
|
107
|
+
*
|
|
108
|
+
*
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
export declare class DescribeTermsCommand extends DescribeTermsCommand_base {
|
|
112
|
+
/** @internal type navigation helper, not in runtime. */
|
|
113
|
+
protected static __types: {
|
|
114
|
+
api: {
|
|
115
|
+
input: DescribeTermsRequest;
|
|
116
|
+
output: DescribeTermsResponse;
|
|
117
|
+
};
|
|
118
|
+
sdk: {
|
|
119
|
+
input: DescribeTermsCommandInput;
|
|
120
|
+
output: DescribeTermsCommandOutput;
|
|
121
|
+
};
|
|
122
|
+
};
|
|
123
|
+
}
|
|
@@ -27,9 +27,12 @@ declare const ForgotPasswordCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Sends a password-reset confirmation code
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Sends a password-reset confirmation code to the email address or phone number of the
|
|
31
|
+
* requested username. The message delivery method is determined by the user's
|
|
32
|
+
* available attributes and the <code>AccountRecoverySetting</code> configuration of the
|
|
33
|
+
* user pool.</p>
|
|
34
|
+
* <p>For the <code>Username</code> parameter, you can use the username or an email, phone,
|
|
35
|
+
* or preferred username alias.</p>
|
|
33
36
|
* <p>If neither a verified phone number nor a verified email exists, Amazon Cognito responds with an
|
|
34
37
|
* <code>InvalidParameterException</code> error . If your app client has a client
|
|
35
38
|
* secret and you don't provide a <code>SECRET_HASH</code> parameter, this API returns
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { GetTokensFromRefreshTokenRequest
|
|
4
|
+
import { GetTokensFromRefreshTokenRequest } from "../models/models_0";
|
|
5
|
+
import { GetTokensFromRefreshTokenResponse } from "../models/models_1";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { GetUICustomizationRequest, GetUICustomizationResponse } from "../models/
|
|
4
|
+
import { GetUICustomizationRequest, GetUICustomizationResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { GetUserAttributeVerificationCodeRequest, GetUserAttributeVerificationCodeResponse } from "../models/
|
|
4
|
+
import { GetUserAttributeVerificationCodeRequest, GetUserAttributeVerificationCodeResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
-
import { GetUserRequest, GetUserResponse } from "../models/
|
|
4
|
+
import { GetUserRequest, GetUserResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
|
|
4
|
+
import { ListTermsRequest, ListTermsResponse } from "../models/models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListTermsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListTermsCommandInput extends ListTermsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListTermsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListTermsCommandOutput extends ListTermsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListTermsCommand_base: {
|
|
25
|
+
new (input: ListTermsCommandInput): import("@smithy/smithy-client").CommandImpl<ListTermsCommandInput, ListTermsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListTermsCommandInput): import("@smithy/smithy-client").CommandImpl<ListTermsCommandInput, ListTermsCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns details about all terms documents for the requested user pool.</p>
|
|
31
|
+
* <note>
|
|
32
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
33
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
34
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
35
|
+
* <p class="title">
|
|
36
|
+
* <b>Learn more</b>
|
|
37
|
+
* </p>
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>
|
|
41
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
42
|
+
* </p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>
|
|
46
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>
|
|
47
|
+
* </p>
|
|
48
|
+
* </li>
|
|
49
|
+
* </ul>
|
|
50
|
+
* </note>
|
|
51
|
+
* @example
|
|
52
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
53
|
+
* ```javascript
|
|
54
|
+
* import { CognitoIdentityProviderClient, ListTermsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
|
|
55
|
+
* // const { CognitoIdentityProviderClient, ListTermsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
|
|
56
|
+
* const client = new CognitoIdentityProviderClient(config);
|
|
57
|
+
* const input = { // ListTermsRequest
|
|
58
|
+
* UserPoolId: "STRING_VALUE", // required
|
|
59
|
+
* MaxResults: Number("int"),
|
|
60
|
+
* NextToken: "STRING_VALUE",
|
|
61
|
+
* };
|
|
62
|
+
* const command = new ListTermsCommand(input);
|
|
63
|
+
* const response = await client.send(command);
|
|
64
|
+
* // { // ListTermsResponse
|
|
65
|
+
* // Terms: [ // TermsDescriptionListType // required
|
|
66
|
+
* // { // TermsDescriptionType
|
|
67
|
+
* // TermsId: "STRING_VALUE", // required
|
|
68
|
+
* // TermsName: "STRING_VALUE", // required
|
|
69
|
+
* // Enforcement: "NONE", // required
|
|
70
|
+
* // CreationDate: new Date("TIMESTAMP"), // required
|
|
71
|
+
* // LastModifiedDate: new Date("TIMESTAMP"), // required
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // NextToken: "STRING_VALUE",
|
|
75
|
+
* // };
|
|
76
|
+
*
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
79
|
+
* @param ListTermsCommandInput - {@link ListTermsCommandInput}
|
|
80
|
+
* @returns {@link ListTermsCommandOutput}
|
|
81
|
+
* @see {@link ListTermsCommandInput} for command's `input` shape.
|
|
82
|
+
* @see {@link ListTermsCommandOutput} for command's `response` shape.
|
|
83
|
+
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InternalErrorException} (server fault)
|
|
86
|
+
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
89
|
+
* <p>This exception is thrown when the Amazon Cognito service encounters an invalid
|
|
90
|
+
* parameter.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link NotAuthorizedException} (client fault)
|
|
93
|
+
* <p>This exception is thrown when a user isn't authorized.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
96
|
+
* <p>This exception is thrown when the Amazon Cognito service can't find the requested
|
|
97
|
+
* resource.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
100
|
+
* <p>This exception is thrown when the user has made too many requests for a given
|
|
101
|
+
* operation.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link CognitoIdentityProviderServiceException}
|
|
104
|
+
* <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
|
|
105
|
+
*
|
|
106
|
+
*
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
export declare class ListTermsCommand extends ListTermsCommand_base {
|
|
110
|
+
/** @internal type navigation helper, not in runtime. */
|
|
111
|
+
protected static __types: {
|
|
112
|
+
api: {
|
|
113
|
+
input: ListTermsRequest;
|
|
114
|
+
output: ListTermsResponse;
|
|
115
|
+
};
|
|
116
|
+
sdk: {
|
|
117
|
+
input: ListTermsCommandInput;
|
|
118
|
+
output: ListTermsCommandOutput;
|
|
119
|
+
};
|
|
120
|
+
};
|
|
121
|
+
}
|
|
@@ -38,7 +38,7 @@ declare const UpdateAuthEventFeedbackCommand_base: {
|
|
|
38
38
|
* invoke this operation when they select the link that corresponds to
|
|
39
39
|
* <code>\{one-click-link-valid\}</code> or <code>\{one-click-link-invalid\}</code> in your
|
|
40
40
|
* notification template. Because <code>FeedbackToken</code> is a required parameter, you
|
|
41
|
-
* can' make requests to <code>UpdateAuthEventFeedback</code> without the contents of
|
|
41
|
+
* can't make requests to <code>UpdateAuthEventFeedback</code> without the contents of
|
|
42
42
|
* the notification email message.</p>
|
|
43
43
|
* <note>
|
|
44
44
|
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
@@ -28,7 +28,7 @@ declare const UpdateManagedLoginBrandingCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Configures the branding settings for a user pool style. This operation is the
|
|
31
|
-
* programmatic option for the configuration of a style in the branding
|
|
31
|
+
* programmatic option for the configuration of a style in the branding editor.</p>
|
|
32
32
|
* <p>Provides values for UI customization in a <code>Settings</code> JSON object and image
|
|
33
33
|
* files in an <code>Assets</code> array.</p>
|
|
34
34
|
* <p> This operation has a 2-megabyte request-size limit and include the CSS settings and
|