@aws-sdk/client-cognito-identity 3.758.0 → 3.768.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 +5 -4
- package/dist-cjs/index.js +10 -10
- package/dist-types/CognitoIdentity.d.ts +5 -4
- package/dist-types/CognitoIdentityClient.d.ts +5 -4
- package/dist-types/commands/CreateIdentityPoolCommand.d.ts +12 -4
- package/dist-types/commands/DeleteIdentitiesCommand.d.ts +2 -1
- package/dist-types/commands/DeleteIdentityPoolCommand.d.ts +2 -1
- package/dist-types/commands/DescribeIdentityCommand.d.ts +2 -1
- package/dist-types/commands/DescribeIdentityPoolCommand.d.ts +2 -1
- package/dist-types/commands/GetCredentialsForIdentityCommand.d.ts +8 -4
- package/dist-types/commands/GetIdCommand.d.ts +1 -1
- package/dist-types/commands/GetIdentityPoolRolesCommand.d.ts +2 -1
- package/dist-types/commands/GetOpenIdTokenForDeveloperIdentityCommand.d.ts +2 -1
- package/dist-types/commands/GetPrincipalTagAttributeMapCommand.d.ts +3 -2
- package/dist-types/commands/ListIdentitiesCommand.d.ts +2 -1
- package/dist-types/commands/ListIdentityPoolsCommand.d.ts +2 -1
- package/dist-types/commands/LookupDeveloperIdentityCommand.d.ts +3 -2
- package/dist-types/commands/MergeDeveloperIdentitiesCommand.d.ts +3 -2
- package/dist-types/commands/SetIdentityPoolRolesCommand.d.ts +2 -1
- package/dist-types/commands/SetPrincipalTagAttributeMapCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UnlinkDeveloperIdentityCommand.d.ts +2 -1
- package/dist-types/commands/UpdateIdentityPoolCommand.d.ts +7 -2
- package/dist-types/index.d.ts +5 -4
- package/dist-types/models/models_0.d.ts +41 -25
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -16,11 +16,12 @@ application.</p>
|
|
|
16
16
|
more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon
|
|
17
17
|
Cognito user pool, and you can also choose to support unauthenticated access from your app.
|
|
18
18
|
Cognito delivers a unique identifier for each user and acts as an OpenID token provider
|
|
19
|
-
trusted by
|
|
20
|
-
credentials.</p>
|
|
19
|
+
trusted by Security Token Service (STS) to access temporary, limited-privilege Amazon Web Services credentials.</p>
|
|
21
20
|
<p>For a description of the authentication flow from the Amazon Cognito Developer Guide
|
|
22
|
-
see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication
|
|
23
|
-
|
|
21
|
+
see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication
|
|
22
|
+
Flow</a>.</p>
|
|
23
|
+
<p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated
|
|
24
|
+
Identities</a>.</p>
|
|
24
25
|
|
|
25
26
|
## Installing
|
|
26
27
|
|
package/dist-cjs/index.js
CHANGED
|
@@ -19,8 +19,8 @@ var __copyProps = (to, from, except, desc) => {
|
|
|
19
19
|
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
20
20
|
|
|
21
21
|
// src/index.ts
|
|
22
|
-
var
|
|
23
|
-
__export(
|
|
22
|
+
var index_exports = {};
|
|
23
|
+
__export(index_exports, {
|
|
24
24
|
AmbiguousRoleResolutionType: () => AmbiguousRoleResolutionType,
|
|
25
25
|
CognitoIdentity: () => CognitoIdentity,
|
|
26
26
|
CognitoIdentityClient: () => CognitoIdentityClient,
|
|
@@ -74,7 +74,7 @@ __export(src_exports, {
|
|
|
74
74
|
__Client: () => import_smithy_client.Client,
|
|
75
75
|
paginateListIdentityPools: () => paginateListIdentityPools
|
|
76
76
|
});
|
|
77
|
-
module.exports = __toCommonJS(
|
|
77
|
+
module.exports = __toCommonJS(index_exports);
|
|
78
78
|
|
|
79
79
|
// src/CognitoIdentityClient.ts
|
|
80
80
|
var import_middleware_host_header = require("@aws-sdk/middleware-host-header");
|
|
@@ -201,9 +201,9 @@ var CognitoIdentityClient = class extends import_smithy_client.Client {
|
|
|
201
201
|
this.middlewareStack.use(
|
|
202
202
|
(0, import_core.getHttpAuthSchemeEndpointRuleSetPlugin)(this.config, {
|
|
203
203
|
httpAuthSchemeParametersProvider: import_httpAuthSchemeProvider.defaultCognitoIdentityHttpAuthSchemeParametersProvider,
|
|
204
|
-
identityProviderConfigProvider: async (config) => new import_core.DefaultIdentityProviderConfig({
|
|
204
|
+
identityProviderConfigProvider: /* @__PURE__ */ __name(async (config) => new import_core.DefaultIdentityProviderConfig({
|
|
205
205
|
"aws.auth#sigv4": config.credentials
|
|
206
|
-
})
|
|
206
|
+
}), "identityProviderConfigProvider")
|
|
207
207
|
})
|
|
208
208
|
);
|
|
209
209
|
this.middlewareStack.use((0, import_core.getHttpSigningPlugin)(this.config));
|
|
@@ -1078,14 +1078,14 @@ var de_TooManyRequestsExceptionRes = /* @__PURE__ */ __name(async (parsedOutput,
|
|
|
1078
1078
|
var de_Credentials = /* @__PURE__ */ __name((output, context) => {
|
|
1079
1079
|
return (0, import_smithy_client.take)(output, {
|
|
1080
1080
|
AccessKeyId: import_smithy_client.expectString,
|
|
1081
|
-
Expiration: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
|
|
1081
|
+
Expiration: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "Expiration"),
|
|
1082
1082
|
SecretKey: import_smithy_client.expectString,
|
|
1083
1083
|
SessionToken: import_smithy_client.expectString
|
|
1084
1084
|
});
|
|
1085
1085
|
}, "de_Credentials");
|
|
1086
1086
|
var de_GetCredentialsForIdentityResponse = /* @__PURE__ */ __name((output, context) => {
|
|
1087
1087
|
return (0, import_smithy_client.take)(output, {
|
|
1088
|
-
Credentials: (_) => de_Credentials(_, context),
|
|
1088
|
+
Credentials: /* @__PURE__ */ __name((_) => de_Credentials(_, context), "Credentials"),
|
|
1089
1089
|
IdentityId: import_smithy_client.expectString
|
|
1090
1090
|
});
|
|
1091
1091
|
}, "de_GetCredentialsForIdentityResponse");
|
|
@@ -1097,15 +1097,15 @@ var de_IdentitiesList = /* @__PURE__ */ __name((output, context) => {
|
|
|
1097
1097
|
}, "de_IdentitiesList");
|
|
1098
1098
|
var de_IdentityDescription = /* @__PURE__ */ __name((output, context) => {
|
|
1099
1099
|
return (0, import_smithy_client.take)(output, {
|
|
1100
|
-
CreationDate: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
|
|
1100
|
+
CreationDate: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "CreationDate"),
|
|
1101
1101
|
IdentityId: import_smithy_client.expectString,
|
|
1102
|
-
LastModifiedDate: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
|
|
1102
|
+
LastModifiedDate: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "LastModifiedDate"),
|
|
1103
1103
|
Logins: import_smithy_client._json
|
|
1104
1104
|
});
|
|
1105
1105
|
}, "de_IdentityDescription");
|
|
1106
1106
|
var de_ListIdentitiesResponse = /* @__PURE__ */ __name((output, context) => {
|
|
1107
1107
|
return (0, import_smithy_client.take)(output, {
|
|
1108
|
-
Identities: (_) => de_IdentitiesList(_, context),
|
|
1108
|
+
Identities: /* @__PURE__ */ __name((_) => de_IdentitiesList(_, context), "Identities"),
|
|
1109
1109
|
IdentityPoolId: import_smithy_client.expectString,
|
|
1110
1110
|
NextToken: import_smithy_client.expectString
|
|
1111
1111
|
});
|
|
@@ -173,11 +173,12 @@ export interface CognitoIdentity {
|
|
|
173
173
|
* more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon
|
|
174
174
|
* Cognito user pool, and you can also choose to support unauthenticated access from your app.
|
|
175
175
|
* Cognito delivers a unique identifier for each user and acts as an OpenID token provider
|
|
176
|
-
* trusted by
|
|
177
|
-
* credentials.</p>
|
|
176
|
+
* trusted by Security Token Service (STS) to access temporary, limited-privilege Amazon Web Services credentials.</p>
|
|
178
177
|
* <p>For a description of the authentication flow from the Amazon Cognito Developer Guide
|
|
179
|
-
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication
|
|
180
|
-
*
|
|
178
|
+
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication
|
|
179
|
+
* Flow</a>.</p>
|
|
180
|
+
* <p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated
|
|
181
|
+
* Identities</a>.</p>
|
|
181
182
|
* @public
|
|
182
183
|
*/
|
|
183
184
|
export declare class CognitoIdentity extends CognitoIdentityClient implements CognitoIdentity {
|
|
@@ -201,11 +201,12 @@ export interface CognitoIdentityClientResolvedConfig extends CognitoIdentityClie
|
|
|
201
201
|
* more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon
|
|
202
202
|
* Cognito user pool, and you can also choose to support unauthenticated access from your app.
|
|
203
203
|
* Cognito delivers a unique identifier for each user and acts as an OpenID token provider
|
|
204
|
-
* trusted by
|
|
205
|
-
* credentials.</p>
|
|
204
|
+
* trusted by Security Token Service (STS) to access temporary, limited-privilege Amazon Web Services credentials.</p>
|
|
206
205
|
* <p>For a description of the authentication flow from the Amazon Cognito Developer Guide
|
|
207
|
-
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication
|
|
208
|
-
*
|
|
206
|
+
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication
|
|
207
|
+
* Flow</a>.</p>
|
|
208
|
+
* <p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated
|
|
209
|
+
* Identities</a>.</p>
|
|
209
210
|
* @public
|
|
210
211
|
*/
|
|
211
212
|
export declare class CognitoIdentityClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CognitoIdentityClientResolvedConfig> {
|
|
@@ -28,8 +28,8 @@ declare const CreateIdentityPoolCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Creates a new identity pool. The identity pool is a store of user identity
|
|
31
|
-
* information that is specific to your
|
|
32
|
-
*
|
|
31
|
+
* information that is specific to your Amazon Web Services account. The keys for
|
|
32
|
+
* <code>SupportedLoginProviders</code> are as follows:</p>
|
|
33
33
|
* <ul>
|
|
34
34
|
* <li>
|
|
35
35
|
* <p>Facebook: <code>graph.facebook.com</code>
|
|
@@ -40,6 +40,10 @@ declare const CreateIdentityPoolCommand_base: {
|
|
|
40
40
|
* </p>
|
|
41
41
|
* </li>
|
|
42
42
|
* <li>
|
|
43
|
+
* <p>Sign in With Apple: <code>appleid.apple.com</code>
|
|
44
|
+
* </p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
43
47
|
* <p>Amazon: <code>www.amazon.com</code>
|
|
44
48
|
* </p>
|
|
45
49
|
* </li>
|
|
@@ -52,8 +56,12 @@ declare const CreateIdentityPoolCommand_base: {
|
|
|
52
56
|
* </p>
|
|
53
57
|
* </li>
|
|
54
58
|
* </ul>
|
|
55
|
-
*
|
|
56
|
-
*
|
|
59
|
+
* <important>
|
|
60
|
+
* <p>If you don't provide a value for a parameter, Amazon Cognito sets it to its default value.
|
|
61
|
+
* </p>
|
|
62
|
+
* </important>
|
|
63
|
+
* <p>You must use Amazon Web Services developer credentials to call this
|
|
64
|
+
* operation.</p>
|
|
57
65
|
* @example
|
|
58
66
|
* Use a bare-bones client and the command you need to make an API call.
|
|
59
67
|
* ```javascript
|
|
@@ -29,7 +29,8 @@ declare const DeleteIdentitiesCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Deletes identities from an identity pool. You can specify a list of 1-60 identities
|
|
31
31
|
* that you want to delete.</p>
|
|
32
|
-
* <p>You must use
|
|
32
|
+
* <p>You must use Amazon Web Services developer credentials to call this
|
|
33
|
+
* operation.</p>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|
|
@@ -29,7 +29,8 @@ declare const DeleteIdentityPoolCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Deletes an identity pool. Once a pool is deleted, users will not be able to
|
|
31
31
|
* authenticate with the pool.</p>
|
|
32
|
-
* <p>You must use
|
|
32
|
+
* <p>You must use Amazon Web Services developer credentials to call this
|
|
33
|
+
* operation.</p>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|
|
@@ -29,7 +29,8 @@ declare const DescribeIdentityCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Returns metadata related to the given identity, including when the identity was
|
|
31
31
|
* created and any associated linked logins.</p>
|
|
32
|
-
* <p>You must use
|
|
32
|
+
* <p>You must use Amazon Web Services developer credentials to call this
|
|
33
|
+
* operation.</p>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|
|
@@ -29,7 +29,8 @@ declare const DescribeIdentityPoolCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Gets details about a particular identity pool, including the pool name, ID
|
|
31
31
|
* description, creation date, and current number of users.</p>
|
|
32
|
-
* <p>You must use
|
|
32
|
+
* <p>You must use Amazon Web Services developer credentials to call this
|
|
33
|
+
* operation.</p>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|
|
@@ -29,8 +29,7 @@ declare const GetCredentialsForIdentityCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Returns credentials for the provided identity ID. Any provided logins will be
|
|
31
31
|
* validated against supported login providers. If the token is for
|
|
32
|
-
*
|
|
33
|
-
* with the appropriate role for the token.</p>
|
|
32
|
+
* <code>cognito-identity.amazonaws.com</code>, it will be passed through to Security Token Service with the appropriate role for the token.</p>
|
|
34
33
|
* <p>This is a public API. You do not need any credentials to call this API.</p>
|
|
35
34
|
* @example
|
|
36
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -73,8 +72,13 @@ declare const GetCredentialsForIdentityCommand_base: {
|
|
|
73
72
|
* <p>Thrown when the service encounters an error during processing the request.</p>
|
|
74
73
|
*
|
|
75
74
|
* @throws {@link InvalidIdentityPoolConfigurationException} (client fault)
|
|
76
|
-
* <p>
|
|
77
|
-
*
|
|
75
|
+
* <p>If you provided authentication information in the request, the identity pool has no
|
|
76
|
+
* authenticated role configured, or STS returned an error response to the
|
|
77
|
+
* request to assume the authenticated role from the identity pool. If you provided no
|
|
78
|
+
* authentication information in the request, the identity pool has no unauthenticated role
|
|
79
|
+
* configured, or STS returned an error response to the request to assume the
|
|
80
|
+
* unauthenticated role from the identity pool.</p>
|
|
81
|
+
* <p>Your role trust policy must grant <code>AssumeRoleWithWebIdentity</code> permissions to <code>cognito-identity.amazonaws.com</code>.</p>
|
|
78
82
|
*
|
|
79
83
|
* @throws {@link InvalidParameterException} (client fault)
|
|
80
84
|
* <p>Thrown for missing or bad input parameter(s).</p>
|
|
@@ -27,7 +27,7 @@ declare const GetIdCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Generates (or retrieves)
|
|
30
|
+
* <p>Generates (or retrieves) IdentityID. Supplying multiple logins will create an
|
|
31
31
|
* implicit linked account.</p>
|
|
32
32
|
* <p>This is a public API. You do not need any credentials to call this API.</p>
|
|
33
33
|
* @example
|
|
@@ -28,7 +28,8 @@ declare const GetIdentityPoolRolesCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Gets the roles for an identity pool.</p>
|
|
31
|
-
* <p>You must use
|
|
31
|
+
* <p>You must use Amazon Web Services developer credentials to call this
|
|
32
|
+
* operation.</p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -39,7 +39,8 @@ declare const GetOpenIdTokenForDeveloperIdentityCommand_base: {
|
|
|
39
39
|
* existing authenticated/unauthenticated identity, you can do so by providing the existing
|
|
40
40
|
* <code>IdentityId</code>. This API will create the identity in the specified
|
|
41
41
|
* <code>IdentityPoolId</code>.</p>
|
|
42
|
-
* <p>You must use
|
|
42
|
+
* <p>You must use Amazon Web Services developer credentials to call this
|
|
43
|
+
* operation.</p>
|
|
43
44
|
* @example
|
|
44
45
|
* Use a bare-bones client and the command you need to make an API call.
|
|
45
46
|
* ```javascript
|
|
@@ -24,10 +24,11 @@ export interface GetPrincipalTagAttributeMapCommandOutput extends GetPrincipalTa
|
|
|
24
24
|
declare const GetPrincipalTagAttributeMapCommand_base: {
|
|
25
25
|
new (input: GetPrincipalTagAttributeMapCommandInput): import("@smithy/smithy-client").CommandImpl<GetPrincipalTagAttributeMapCommandInput, GetPrincipalTagAttributeMapCommandOutput, CognitoIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
26
|
new (__0_0: GetPrincipalTagAttributeMapCommandInput): import("@smithy/smithy-client").CommandImpl<GetPrincipalTagAttributeMapCommandInput, GetPrincipalTagAttributeMapCommandOutput, CognitoIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; /** @internal type navigation helper, not in runtime. */
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Use <code>GetPrincipalTagAttributeMap</code> to list all mappings between
|
|
30
|
+
* <p>Use <code>GetPrincipalTagAttributeMap</code> to list all mappings between
|
|
31
|
+
* <code>PrincipalTags</code> and user attributes.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -28,7 +28,8 @@ declare const ListIdentitiesCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Lists the identities in an identity pool.</p>
|
|
31
|
-
* <p>You must use
|
|
31
|
+
* <p>You must use Amazon Web Services developer credentials to call this
|
|
32
|
+
* operation.</p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -28,7 +28,8 @@ declare const ListIdentityPoolsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Lists all of the Cognito identity pools registered for your account.</p>
|
|
31
|
-
* <p>You must use
|
|
31
|
+
* <p>You must use Amazon Web Services developer credentials to call this
|
|
32
|
+
* operation.</p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -35,7 +35,7 @@ declare const LookupDeveloperIdentityCommand_base: {
|
|
|
35
35
|
* returned as a part of the response. If you supply both,
|
|
36
36
|
* <code>DeveloperUserIdentifier</code> will be matched against <code>IdentityID</code>. If
|
|
37
37
|
* the values are verified against the database, the response returns both values and is the
|
|
38
|
-
* same as the request. Otherwise a <code>ResourceConflictException</code> is
|
|
38
|
+
* same as the request. Otherwise, a <code>ResourceConflictException</code> is
|
|
39
39
|
* thrown.</p>
|
|
40
40
|
* <p>
|
|
41
41
|
* <code>LookupDeveloperIdentity</code> is intended for low-throughput control plane
|
|
@@ -43,7 +43,8 @@ declare const LookupDeveloperIdentityCommand_base: {
|
|
|
43
43
|
* If you are using it for higher-volume operations such as user authentication, your requests
|
|
44
44
|
* are likely to be throttled. <a>GetOpenIdTokenForDeveloperIdentity</a> is a
|
|
45
45
|
* better option for higher-volume operations for user authentication.</p>
|
|
46
|
-
* <p>You must use
|
|
46
|
+
* <p>You must use Amazon Web Services developer credentials to call this
|
|
47
|
+
* operation.</p>
|
|
47
48
|
* @example
|
|
48
49
|
* Use a bare-bones client and the command you need to make an API call.
|
|
49
50
|
* ```javascript
|
|
@@ -37,9 +37,10 @@ declare const MergeDeveloperIdentitiesCommand_base: {
|
|
|
37
37
|
* thrown.</p>
|
|
38
38
|
* <p>The number of linked logins is limited to 20. So, the number of linked logins for the
|
|
39
39
|
* source user, <code>SourceUserIdentifier</code>, and the destination user,
|
|
40
|
-
*
|
|
40
|
+
* <code>DestinationUserIdentifier</code>, together should not be larger than 20.
|
|
41
41
|
* Otherwise, an exception will be thrown.</p>
|
|
42
|
-
* <p>You must use
|
|
42
|
+
* <p>You must use Amazon Web Services developer credentials to call this
|
|
43
|
+
* operation.</p>
|
|
43
44
|
* @example
|
|
44
45
|
* Use a bare-bones client and the command you need to make an API call.
|
|
45
46
|
* ```javascript
|
|
@@ -28,7 +28,8 @@ declare const SetIdentityPoolRolesCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Sets the roles for an identity pool. These roles are used when making calls to <a>GetCredentialsForIdentity</a> action.</p>
|
|
31
|
-
* <p>You must use
|
|
31
|
+
* <p>You must use Amazon Web Services developer credentials to call this
|
|
32
|
+
* operation.</p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -27,7 +27,8 @@ declare const SetPrincipalTagAttributeMapCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>You can use this operation to use default (username and clientID) attribute or custom
|
|
30
|
+
* <p>You can use this operation to use default (username and clientID) attribute or custom
|
|
31
|
+
* attribute mappings.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -38,8 +38,8 @@ declare const TagResourceCommand_base: {
|
|
|
38
38
|
* other.</p>
|
|
39
39
|
* <p>Tags are useful for cost tracking and access control. You can activate your tags so that
|
|
40
40
|
* they appear on the Billing and Cost Management console, where you can track the costs
|
|
41
|
-
* associated with your identity pools. In an IAM policy, you can constrain
|
|
42
|
-
* identity pools based on specific tags or tag values.</p>
|
|
41
|
+
* associated with your identity pools. In an IAM policy, you can constrain
|
|
42
|
+
* permissions for identity pools based on specific tags or tag values.</p>
|
|
43
43
|
* <p>You can use this action up to 5 times per second, per account. An identity pool can have
|
|
44
44
|
* as many as 50 tags.</p>
|
|
45
45
|
* @example
|
|
@@ -31,7 +31,8 @@ declare const UnlinkDeveloperIdentityCommand_base: {
|
|
|
31
31
|
* developer users will be considered new identities next time they are seen. If, for a given
|
|
32
32
|
* Cognito identity, you remove all federated identities as well as the developer user
|
|
33
33
|
* identifier, the Cognito identity becomes inaccessible.</p>
|
|
34
|
-
* <p>You must use
|
|
34
|
+
* <p>You must use Amazon Web Services developer credentials to call this
|
|
35
|
+
* operation.</p>
|
|
35
36
|
* @example
|
|
36
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
38
|
* ```javascript
|
|
@@ -27,8 +27,13 @@ declare const UpdateIdentityPoolCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates an identity pool.</p>
|
|
31
|
-
* <
|
|
30
|
+
* <p>Updates the configuration of an identity pool.</p>
|
|
31
|
+
* <important>
|
|
32
|
+
* <p>If you don't provide a value for a parameter, Amazon Cognito sets it to its default value.
|
|
33
|
+
* </p>
|
|
34
|
+
* </important>
|
|
35
|
+
* <p>You must use Amazon Web Services developer credentials to call this
|
|
36
|
+
* operation.</p>
|
|
32
37
|
* @example
|
|
33
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
39
|
* ```javascript
|
package/dist-types/index.d.ts
CHANGED
|
@@ -8,11 +8,12 @@
|
|
|
8
8
|
* more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon
|
|
9
9
|
* Cognito user pool, and you can also choose to support unauthenticated access from your app.
|
|
10
10
|
* Cognito delivers a unique identifier for each user and acts as an OpenID token provider
|
|
11
|
-
* trusted by
|
|
12
|
-
* credentials.</p>
|
|
11
|
+
* trusted by Security Token Service (STS) to access temporary, limited-privilege Amazon Web Services credentials.</p>
|
|
13
12
|
* <p>For a description of the authentication flow from the Amazon Cognito Developer Guide
|
|
14
|
-
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication
|
|
15
|
-
*
|
|
13
|
+
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication
|
|
14
|
+
* Flow</a>.</p>
|
|
15
|
+
* <p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated
|
|
16
|
+
* Identities</a>.</p>
|
|
16
17
|
*
|
|
17
18
|
* @packageDocumentation
|
|
18
19
|
*/
|
|
@@ -33,8 +33,8 @@ export interface CognitoIdentityProvider {
|
|
|
33
33
|
* token.</p>
|
|
34
34
|
* <p>Once you set <code>ServerSideTokenCheck</code> to TRUE for an identity pool, that
|
|
35
35
|
* identity pool will check with the integrated user pools to make sure that the user has not
|
|
36
|
-
* been globally signed out or deleted before the identity pool provides an OIDC token or
|
|
37
|
-
*
|
|
36
|
+
* been globally signed out or deleted before the identity pool provides an OIDC token or
|
|
37
|
+
* Amazon Web Services credentials for the user.</p>
|
|
38
38
|
* <p>If the user is signed out or deleted, the identity pool will return a 400 Not
|
|
39
39
|
* Authorized error.</p>
|
|
40
40
|
* @public
|
|
@@ -58,7 +58,8 @@ export interface CreateIdentityPoolInput {
|
|
|
58
58
|
AllowUnauthenticatedIdentities: boolean | undefined;
|
|
59
59
|
/**
|
|
60
60
|
* <p>Enables or disables the Basic (Classic) authentication flow. For more information, see
|
|
61
|
-
*
|
|
61
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Identity Pools (Federated Identities) Authentication Flow</a> in the
|
|
62
|
+
* <i>Amazon Cognito Developer Guide</i>.</p>
|
|
62
63
|
* @public
|
|
63
64
|
*/
|
|
64
65
|
AllowClassicFlow?: boolean | undefined;
|
|
@@ -124,7 +125,8 @@ export interface IdentityPool {
|
|
|
124
125
|
AllowUnauthenticatedIdentities: boolean | undefined;
|
|
125
126
|
/**
|
|
126
127
|
* <p>Enables or disables the Basic (Classic) authentication flow. For more information, see
|
|
127
|
-
*
|
|
128
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Identity Pools (Federated Identities) Authentication Flow</a> in the
|
|
129
|
+
* <i>Amazon Cognito Developer Guide</i>.</p>
|
|
128
130
|
* @public
|
|
129
131
|
*/
|
|
130
132
|
AllowClassicFlow?: boolean | undefined;
|
|
@@ -391,8 +393,8 @@ export interface GetCredentialsForIdentityInput {
|
|
|
391
393
|
* identity.</p>
|
|
392
394
|
* <p>The Logins parameter is required when using identities associated with external
|
|
393
395
|
* identity providers such as Facebook. For examples of <code>Logins</code> maps, see the code
|
|
394
|
-
* examples in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html">External Identity
|
|
395
|
-
*
|
|
396
|
+
* examples in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html">External Identity
|
|
397
|
+
* Providers</a> section of the Amazon Cognito Developer Guide.</p>
|
|
396
398
|
* @public
|
|
397
399
|
*/
|
|
398
400
|
Logins?: Record<string, string> | undefined;
|
|
@@ -449,8 +451,13 @@ export interface GetCredentialsForIdentityResponse {
|
|
|
449
451
|
Credentials?: Credentials | undefined;
|
|
450
452
|
}
|
|
451
453
|
/**
|
|
452
|
-
* <p>
|
|
453
|
-
*
|
|
454
|
+
* <p>If you provided authentication information in the request, the identity pool has no
|
|
455
|
+
* authenticated role configured, or STS returned an error response to the
|
|
456
|
+
* request to assume the authenticated role from the identity pool. If you provided no
|
|
457
|
+
* authentication information in the request, the identity pool has no unauthenticated role
|
|
458
|
+
* configured, or STS returned an error response to the request to assume the
|
|
459
|
+
* unauthenticated role from the identity pool.</p>
|
|
460
|
+
* <p>Your role trust policy must grant <code>AssumeRoleWithWebIdentity</code> permissions to <code>cognito-identity.amazonaws.com</code>.</p>
|
|
454
461
|
* @public
|
|
455
462
|
*/
|
|
456
463
|
export declare class InvalidIdentityPoolConfigurationException extends __BaseException {
|
|
@@ -467,7 +474,7 @@ export declare class InvalidIdentityPoolConfigurationException extends __BaseExc
|
|
|
467
474
|
*/
|
|
468
475
|
export interface GetIdInput {
|
|
469
476
|
/**
|
|
470
|
-
* <p>A standard
|
|
477
|
+
* <p>A standard Amazon Web Services account ID (9+ digits).</p>
|
|
471
478
|
* @public
|
|
472
479
|
*/
|
|
473
480
|
AccountId?: string | undefined;
|
|
@@ -651,8 +658,8 @@ export interface GetIdentityPoolRolesResponse {
|
|
|
651
658
|
/**
|
|
652
659
|
* <p>How users for a specific identity provider are to mapped to roles. This is a
|
|
653
660
|
* String-to-<a>RoleMapping</a> object map. The string identifies the identity
|
|
654
|
-
* provider, for example,
|
|
655
|
-
*
|
|
661
|
+
* provider, for example, <code>graph.facebook.com</code> or
|
|
662
|
+
* <code>cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id</code>.</p>
|
|
656
663
|
* @public
|
|
657
664
|
*/
|
|
658
665
|
RoleMappings?: Record<string, RoleMapping> | undefined;
|
|
@@ -741,13 +748,14 @@ export interface GetOpenIdTokenForDeveloperIdentityInput {
|
|
|
741
748
|
/**
|
|
742
749
|
* <p>The expiration time of the token, in seconds. You can specify a custom expiration
|
|
743
750
|
* time for the token so that you can cache it. If you don't provide an expiration time, the
|
|
744
|
-
* token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary
|
|
745
|
-
*
|
|
746
|
-
* set is 24 hours. You should take care in setting the expiration time
|
|
747
|
-
* are significant security implications: an attacker could use a leaked
|
|
748
|
-
*
|
|
751
|
+
* token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary
|
|
752
|
+
* Amazon Web Services credentials, which are valid for a maximum of one hour. The maximum
|
|
753
|
+
* token duration you can set is 24 hours. You should take care in setting the expiration time
|
|
754
|
+
* for a token, as there are significant security implications: an attacker could use a leaked
|
|
755
|
+
* token to access your Amazon Web Services resources for the token's duration.</p>
|
|
749
756
|
* <note>
|
|
750
|
-
* <p>Please provide for a small grace period, usually no more than 5 minutes, to
|
|
757
|
+
* <p>Please provide for a small grace period, usually no more than 5 minutes, to
|
|
758
|
+
* account for clock skew.</p>
|
|
751
759
|
* </note>
|
|
752
760
|
* @public
|
|
753
761
|
*/
|
|
@@ -775,7 +783,8 @@ export interface GetOpenIdTokenForDeveloperIdentityResponse {
|
|
|
775
783
|
*/
|
|
776
784
|
export interface GetPrincipalTagAttributeMapInput {
|
|
777
785
|
/**
|
|
778
|
-
* <p>You can use this operation to get the ID of the Identity Pool you setup attribute
|
|
786
|
+
* <p>You can use this operation to get the ID of the Identity Pool you setup attribute
|
|
787
|
+
* mappings for.</p>
|
|
779
788
|
* @public
|
|
780
789
|
*/
|
|
781
790
|
IdentityPoolId: string | undefined;
|
|
@@ -790,7 +799,8 @@ export interface GetPrincipalTagAttributeMapInput {
|
|
|
790
799
|
*/
|
|
791
800
|
export interface GetPrincipalTagAttributeMapResponse {
|
|
792
801
|
/**
|
|
793
|
-
* <p>You can use this operation to get the ID of the Identity Pool you setup attribute
|
|
802
|
+
* <p>You can use this operation to get the ID of the Identity Pool you setup attribute
|
|
803
|
+
* mappings for.</p>
|
|
794
804
|
* @public
|
|
795
805
|
*/
|
|
796
806
|
IdentityPoolId?: string | undefined;
|
|
@@ -805,7 +815,9 @@ export interface GetPrincipalTagAttributeMapResponse {
|
|
|
805
815
|
*/
|
|
806
816
|
UseDefaults?: boolean | undefined;
|
|
807
817
|
/**
|
|
808
|
-
* <p>You can use this operation to add principal tags. The
|
|
818
|
+
* <p>You can use this operation to add principal tags. The
|
|
819
|
+
* <code>PrincipalTags</code>operation enables you to reference user attributes in your
|
|
820
|
+
* IAM permissions policy.</p>
|
|
809
821
|
* @public
|
|
810
822
|
*/
|
|
811
823
|
PrincipalTags?: Record<string, string> | undefined;
|
|
@@ -1069,8 +1081,8 @@ export interface SetIdentityPoolRolesInput {
|
|
|
1069
1081
|
/**
|
|
1070
1082
|
* <p>How users for a specific identity provider are to mapped to roles. This is a string
|
|
1071
1083
|
* to <a>RoleMapping</a> object map. The string identifies the identity provider,
|
|
1072
|
-
* for example,
|
|
1073
|
-
*
|
|
1084
|
+
* for example, <code>graph.facebook.com</code> or
|
|
1085
|
+
* <code>cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id</code>.</p>
|
|
1074
1086
|
* <p>Up to 25 rules can be specified per identity provider.</p>
|
|
1075
1087
|
* @public
|
|
1076
1088
|
*/
|
|
@@ -1091,7 +1103,8 @@ export interface SetPrincipalTagAttributeMapInput {
|
|
|
1091
1103
|
*/
|
|
1092
1104
|
IdentityProviderName: string | undefined;
|
|
1093
1105
|
/**
|
|
1094
|
-
* <p>You can use this operation to use default (username and clientID) attribute
|
|
1106
|
+
* <p>You can use this operation to use default (username and clientID) attribute
|
|
1107
|
+
* mappings.</p>
|
|
1095
1108
|
* @public
|
|
1096
1109
|
*/
|
|
1097
1110
|
UseDefaults?: boolean | undefined;
|
|
@@ -1116,12 +1129,15 @@ export interface SetPrincipalTagAttributeMapResponse {
|
|
|
1116
1129
|
*/
|
|
1117
1130
|
IdentityProviderName?: string | undefined;
|
|
1118
1131
|
/**
|
|
1119
|
-
* <p>You can use this operation to select default (username and clientID) attribute
|
|
1132
|
+
* <p>You can use this operation to select default (username and clientID) attribute
|
|
1133
|
+
* mappings.</p>
|
|
1120
1134
|
* @public
|
|
1121
1135
|
*/
|
|
1122
1136
|
UseDefaults?: boolean | undefined;
|
|
1123
1137
|
/**
|
|
1124
|
-
* <p>You can use this operation to add principal tags. The
|
|
1138
|
+
* <p>You can use this operation to add principal tags. The
|
|
1139
|
+
* <code>PrincipalTags</code>operation enables you to reference user attributes in your
|
|
1140
|
+
* IAM permissions policy.</p>
|
|
1125
1141
|
* @public
|
|
1126
1142
|
*/
|
|
1127
1143
|
PrincipalTags?: Record<string, string> | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-cognito-identity",
|
|
3
3
|
"description": "AWS SDK for JavaScript Cognito Identity Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.768.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-cognito-identity",
|