@aws-sdk/client-cognito-identity-provider 3.379.1 → 3.383.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 +83 -6
- package/dist-cjs/CognitoIdentityProvider.js +4 -0
- package/dist-cjs/commands/GetLogDeliveryConfigurationCommand.js +48 -0
- package/dist-cjs/commands/SetLogDeliveryConfigurationCommand.js +48 -0
- package/dist-cjs/commands/SetRiskConfigurationCommand.js +2 -1
- package/dist-cjs/commands/SetUICustomizationCommand.js +3 -3
- package/dist-cjs/commands/SetUserMFAPreferenceCommand.js +2 -2
- package/dist-cjs/commands/SetUserSettingsCommand.js +2 -2
- package/dist-cjs/commands/VerifySoftwareTokenCommand.js +1 -1
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/models/models_0.js +9 -48
- package/dist-cjs/models/models_1.js +26 -9
- package/dist-cjs/protocols/Aws_json1_1.js +108 -4
- package/dist-es/CognitoIdentityProvider.js +4 -0
- package/dist-es/commands/GetLogDeliveryConfigurationCommand.js +44 -0
- package/dist-es/commands/SetLogDeliveryConfigurationCommand.js +44 -0
- package/dist-es/commands/SetRiskConfigurationCommand.js +2 -1
- package/dist-es/commands/SetUICustomizationCommand.js +1 -1
- package/dist-es/commands/SetUserMFAPreferenceCommand.js +1 -1
- package/dist-es/commands/SetUserSettingsCommand.js +1 -1
- package/dist-es/commands/VerifySoftwareTokenCommand.js +2 -2
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +6 -39
- package/dist-es/models/models_1.js +21 -8
- package/dist-es/protocols/Aws_json1_1.js +100 -0
- package/dist-types/CognitoIdentityProvider.d.ts +81 -6
- package/dist-types/CognitoIdentityProviderClient.d.ts +71 -8
- package/dist-types/commands/AddCustomAttributesCommand.d.ts +20 -0
- package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +20 -1
- package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +20 -1
- package/dist-types/commands/AdminCreateUserCommand.d.ts +22 -4
- package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +20 -1
- package/dist-types/commands/AdminDeleteUserCommand.d.ts +20 -1
- package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +22 -4
- package/dist-types/commands/AdminDisableUserCommand.d.ts +23 -3
- package/dist-types/commands/AdminEnableUserCommand.d.ts +20 -1
- package/dist-types/commands/AdminForgetDeviceCommand.d.ts +20 -1
- package/dist-types/commands/AdminGetDeviceCommand.d.ts +20 -1
- package/dist-types/commands/AdminGetUserCommand.d.ts +20 -1
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +22 -3
- package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +22 -3
- package/dist-types/commands/AdminListDevicesCommand.d.ts +20 -1
- package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +20 -1
- package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +20 -0
- package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +20 -1
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +30 -11
- package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +24 -5
- package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +20 -0
- package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +31 -0
- package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +20 -0
- package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +20 -0
- package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +20 -1
- package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +31 -12
- package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +28 -7
- package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +8 -1
- package/dist-types/commands/ChangePasswordCommand.d.ts +8 -1
- package/dist-types/commands/ConfirmDeviceCommand.d.ts +8 -1
- package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +8 -1
- package/dist-types/commands/ConfirmSignUpCommand.d.ts +10 -3
- package/dist-types/commands/CreateGroupCommand.d.ts +20 -1
- package/dist-types/commands/CreateIdentityProviderCommand.d.ts +20 -0
- package/dist-types/commands/CreateResourceServerCommand.d.ts +20 -0
- package/dist-types/commands/CreateUserImportJobCommand.d.ts +21 -1
- package/dist-types/commands/CreateUserPoolClientCommand.d.ts +23 -0
- package/dist-types/commands/CreateUserPoolCommand.d.ts +28 -5
- package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +20 -0
- package/dist-types/commands/DeleteUserAttributesCommand.d.ts +8 -1
- package/dist-types/commands/DeleteUserCommand.d.ts +9 -2
- package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +20 -0
- package/dist-types/commands/DescribeUserPoolCommand.d.ts +20 -0
- package/dist-types/commands/ForgetDeviceCommand.d.ts +8 -1
- package/dist-types/commands/ForgotPasswordCommand.d.ts +16 -7
- package/dist-types/commands/GetDeviceCommand.d.ts +8 -1
- package/dist-types/commands/GetLogDeliveryConfigurationCommand.d.ts +102 -0
- package/dist-types/commands/GetSigningCertificateCommand.d.ts +5 -3
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +10 -3
- package/dist-types/commands/GetUserCommand.d.ts +8 -1
- package/dist-types/commands/GlobalSignOutCommand.d.ts +16 -4
- package/dist-types/commands/InitiateAuthCommand.d.ts +10 -3
- package/dist-types/commands/ListDevicesCommand.d.ts +8 -1
- package/dist-types/commands/ListGroupsCommand.d.ts +20 -1
- package/dist-types/commands/ListIdentityProvidersCommand.d.ts +20 -0
- package/dist-types/commands/ListResourceServersCommand.d.ts +20 -0
- package/dist-types/commands/ListUserImportJobsCommand.d.ts +21 -1
- package/dist-types/commands/ListUserPoolClientsCommand.d.ts +20 -0
- package/dist-types/commands/ListUserPoolsCommand.d.ts +20 -0
- package/dist-types/commands/ListUsersCommand.d.ts +21 -1
- package/dist-types/commands/ListUsersInGroupCommand.d.ts +20 -1
- package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +10 -3
- package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +12 -5
- package/dist-types/commands/RevokeTokenCommand.d.ts +10 -3
- package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +111 -0
- package/dist-types/commands/SetRiskConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/SetUICustomizationCommand.d.ts +1 -1
- package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +9 -2
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +3 -3
- package/dist-types/commands/SetUserSettingsCommand.d.ts +9 -2
- package/dist-types/commands/SignUpCommand.d.ts +10 -3
- package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +6 -0
- package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +8 -1
- package/dist-types/commands/UpdateGroupCommand.d.ts +20 -1
- package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +20 -0
- package/dist-types/commands/UpdateResourceServerCommand.d.ts +20 -0
- package/dist-types/commands/UpdateUserAttributesCommand.d.ts +12 -5
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +21 -2
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +28 -7
- package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +20 -0
- package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +8 -1
- package/dist-types/commands/VerifyUserAttributeCommand.d.ts +13 -9
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +67 -6
- package/dist-types/models/models_0.d.ts +1045 -304
- package/dist-types/models/models_1.d.ts +348 -18
- package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
- package/dist-types/ts3.4/CognitoIdentityProvider.d.ts +34 -0
- package/dist-types/ts3.4/CognitoIdentityProviderClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/GetLogDeliveryConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/SetLogDeliveryConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/SetRiskConfigurationCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SetUICustomizationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetUserMFAPreferenceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetUserPoolMfaConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SetUserSettingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +34 -52
- package/dist-types/ts3.4/models/models_1.d.ts +56 -3
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
- package/package.json +5 -5
|
@@ -363,6 +363,12 @@ export const se_GetIdentityProviderByIdentifierCommand = async (input, context)
|
|
|
363
363
|
body = JSON.stringify(_json(input));
|
|
364
364
|
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
365
365
|
};
|
|
366
|
+
export const se_GetLogDeliveryConfigurationCommand = async (input, context) => {
|
|
367
|
+
const headers = sharedHeaders("GetLogDeliveryConfiguration");
|
|
368
|
+
let body;
|
|
369
|
+
body = JSON.stringify(_json(input));
|
|
370
|
+
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
371
|
+
};
|
|
366
372
|
export const se_GetSigningCertificateCommand = async (input, context) => {
|
|
367
373
|
const headers = sharedHeaders("GetSigningCertificate");
|
|
368
374
|
let body;
|
|
@@ -483,6 +489,12 @@ export const se_RevokeTokenCommand = async (input, context) => {
|
|
|
483
489
|
body = JSON.stringify(_json(input));
|
|
484
490
|
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
485
491
|
};
|
|
492
|
+
export const se_SetLogDeliveryConfigurationCommand = async (input, context) => {
|
|
493
|
+
const headers = sharedHeaders("SetLogDeliveryConfiguration");
|
|
494
|
+
let body;
|
|
495
|
+
body = JSON.stringify(_json(input));
|
|
496
|
+
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
497
|
+
};
|
|
486
498
|
export const se_SetRiskConfigurationCommand = async (input, context) => {
|
|
487
499
|
const headers = sharedHeaders("SetRiskConfiguration");
|
|
488
500
|
let body;
|
|
@@ -3726,6 +3738,50 @@ const de_GetIdentityProviderByIdentifierCommandError = async (output, context) =
|
|
|
3726
3738
|
});
|
|
3727
3739
|
}
|
|
3728
3740
|
};
|
|
3741
|
+
export const de_GetLogDeliveryConfigurationCommand = async (output, context) => {
|
|
3742
|
+
if (output.statusCode >= 300) {
|
|
3743
|
+
return de_GetLogDeliveryConfigurationCommandError(output, context);
|
|
3744
|
+
}
|
|
3745
|
+
const data = await parseBody(output.body, context);
|
|
3746
|
+
let contents = {};
|
|
3747
|
+
contents = _json(data);
|
|
3748
|
+
const response = {
|
|
3749
|
+
$metadata: deserializeMetadata(output),
|
|
3750
|
+
...contents,
|
|
3751
|
+
};
|
|
3752
|
+
return response;
|
|
3753
|
+
};
|
|
3754
|
+
const de_GetLogDeliveryConfigurationCommandError = async (output, context) => {
|
|
3755
|
+
const parsedOutput = {
|
|
3756
|
+
...output,
|
|
3757
|
+
body: await parseErrorBody(output.body, context),
|
|
3758
|
+
};
|
|
3759
|
+
const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
|
|
3760
|
+
switch (errorCode) {
|
|
3761
|
+
case "InternalErrorException":
|
|
3762
|
+
case "com.amazonaws.cognitoidentityprovider#InternalErrorException":
|
|
3763
|
+
throw await de_InternalErrorExceptionRes(parsedOutput, context);
|
|
3764
|
+
case "InvalidParameterException":
|
|
3765
|
+
case "com.amazonaws.cognitoidentityprovider#InvalidParameterException":
|
|
3766
|
+
throw await de_InvalidParameterExceptionRes(parsedOutput, context);
|
|
3767
|
+
case "NotAuthorizedException":
|
|
3768
|
+
case "com.amazonaws.cognitoidentityprovider#NotAuthorizedException":
|
|
3769
|
+
throw await de_NotAuthorizedExceptionRes(parsedOutput, context);
|
|
3770
|
+
case "ResourceNotFoundException":
|
|
3771
|
+
case "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException":
|
|
3772
|
+
throw await de_ResourceNotFoundExceptionRes(parsedOutput, context);
|
|
3773
|
+
case "TooManyRequestsException":
|
|
3774
|
+
case "com.amazonaws.cognitoidentityprovider#TooManyRequestsException":
|
|
3775
|
+
throw await de_TooManyRequestsExceptionRes(parsedOutput, context);
|
|
3776
|
+
default:
|
|
3777
|
+
const parsedBody = parsedOutput.body;
|
|
3778
|
+
return throwDefaultError({
|
|
3779
|
+
output,
|
|
3780
|
+
parsedBody,
|
|
3781
|
+
errorCode,
|
|
3782
|
+
});
|
|
3783
|
+
}
|
|
3784
|
+
};
|
|
3729
3785
|
export const de_GetSigningCertificateCommand = async (output, context) => {
|
|
3730
3786
|
if (output.statusCode >= 300) {
|
|
3731
3787
|
return de_GetSigningCertificateCommandError(output, context);
|
|
@@ -4783,6 +4839,50 @@ const de_RevokeTokenCommandError = async (output, context) => {
|
|
|
4783
4839
|
});
|
|
4784
4840
|
}
|
|
4785
4841
|
};
|
|
4842
|
+
export const de_SetLogDeliveryConfigurationCommand = async (output, context) => {
|
|
4843
|
+
if (output.statusCode >= 300) {
|
|
4844
|
+
return de_SetLogDeliveryConfigurationCommandError(output, context);
|
|
4845
|
+
}
|
|
4846
|
+
const data = await parseBody(output.body, context);
|
|
4847
|
+
let contents = {};
|
|
4848
|
+
contents = _json(data);
|
|
4849
|
+
const response = {
|
|
4850
|
+
$metadata: deserializeMetadata(output),
|
|
4851
|
+
...contents,
|
|
4852
|
+
};
|
|
4853
|
+
return response;
|
|
4854
|
+
};
|
|
4855
|
+
const de_SetLogDeliveryConfigurationCommandError = async (output, context) => {
|
|
4856
|
+
const parsedOutput = {
|
|
4857
|
+
...output,
|
|
4858
|
+
body: await parseErrorBody(output.body, context),
|
|
4859
|
+
};
|
|
4860
|
+
const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
|
|
4861
|
+
switch (errorCode) {
|
|
4862
|
+
case "InternalErrorException":
|
|
4863
|
+
case "com.amazonaws.cognitoidentityprovider#InternalErrorException":
|
|
4864
|
+
throw await de_InternalErrorExceptionRes(parsedOutput, context);
|
|
4865
|
+
case "InvalidParameterException":
|
|
4866
|
+
case "com.amazonaws.cognitoidentityprovider#InvalidParameterException":
|
|
4867
|
+
throw await de_InvalidParameterExceptionRes(parsedOutput, context);
|
|
4868
|
+
case "NotAuthorizedException":
|
|
4869
|
+
case "com.amazonaws.cognitoidentityprovider#NotAuthorizedException":
|
|
4870
|
+
throw await de_NotAuthorizedExceptionRes(parsedOutput, context);
|
|
4871
|
+
case "ResourceNotFoundException":
|
|
4872
|
+
case "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException":
|
|
4873
|
+
throw await de_ResourceNotFoundExceptionRes(parsedOutput, context);
|
|
4874
|
+
case "TooManyRequestsException":
|
|
4875
|
+
case "com.amazonaws.cognitoidentityprovider#TooManyRequestsException":
|
|
4876
|
+
throw await de_TooManyRequestsExceptionRes(parsedOutput, context);
|
|
4877
|
+
default:
|
|
4878
|
+
const parsedBody = parsedOutput.body;
|
|
4879
|
+
return throwDefaultError({
|
|
4880
|
+
output,
|
|
4881
|
+
parsedBody,
|
|
4882
|
+
errorCode,
|
|
4883
|
+
});
|
|
4884
|
+
}
|
|
4885
|
+
};
|
|
4786
4886
|
export const de_SetRiskConfigurationCommand = async (output, context) => {
|
|
4787
4887
|
if (output.statusCode >= 300) {
|
|
4788
4888
|
return de_SetRiskConfigurationCommandError(output, context);
|
|
@@ -60,6 +60,7 @@ import { GetCSVHeaderCommandInput, GetCSVHeaderCommandOutput } from "./commands/
|
|
|
60
60
|
import { GetDeviceCommandInput, GetDeviceCommandOutput } from "./commands/GetDeviceCommand";
|
|
61
61
|
import { GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
|
|
62
62
|
import { GetIdentityProviderByIdentifierCommandInput, GetIdentityProviderByIdentifierCommandOutput } from "./commands/GetIdentityProviderByIdentifierCommand";
|
|
63
|
+
import { GetLogDeliveryConfigurationCommandInput, GetLogDeliveryConfigurationCommandOutput } from "./commands/GetLogDeliveryConfigurationCommand";
|
|
63
64
|
import { GetSigningCertificateCommandInput, GetSigningCertificateCommandOutput } from "./commands/GetSigningCertificateCommand";
|
|
64
65
|
import { GetUICustomizationCommandInput, GetUICustomizationCommandOutput } from "./commands/GetUICustomizationCommand";
|
|
65
66
|
import { GetUserAttributeVerificationCodeCommandInput, GetUserAttributeVerificationCodeCommandOutput } from "./commands/GetUserAttributeVerificationCodeCommand";
|
|
@@ -80,6 +81,7 @@ import { ListUsersInGroupCommandInput, ListUsersInGroupCommandOutput } from "./c
|
|
|
80
81
|
import { ResendConfirmationCodeCommandInput, ResendConfirmationCodeCommandOutput } from "./commands/ResendConfirmationCodeCommand";
|
|
81
82
|
import { RespondToAuthChallengeCommandInput, RespondToAuthChallengeCommandOutput } from "./commands/RespondToAuthChallengeCommand";
|
|
82
83
|
import { RevokeTokenCommandInput, RevokeTokenCommandOutput } from "./commands/RevokeTokenCommand";
|
|
84
|
+
import { SetLogDeliveryConfigurationCommandInput, SetLogDeliveryConfigurationCommandOutput } from "./commands/SetLogDeliveryConfigurationCommand";
|
|
83
85
|
import { SetRiskConfigurationCommandInput, SetRiskConfigurationCommandOutput } from "./commands/SetRiskConfigurationCommand";
|
|
84
86
|
import { SetUICustomizationCommandInput, SetUICustomizationCommandOutput } from "./commands/SetUICustomizationCommand";
|
|
85
87
|
import { SetUserMFAPreferenceCommandInput, SetUserMFAPreferenceCommandOutput } from "./commands/SetUserMFAPreferenceCommand";
|
|
@@ -462,6 +464,12 @@ export interface CognitoIdentityProvider {
|
|
|
462
464
|
getIdentityProviderByIdentifier(args: GetIdentityProviderByIdentifierCommandInput, options?: __HttpHandlerOptions): Promise<GetIdentityProviderByIdentifierCommandOutput>;
|
|
463
465
|
getIdentityProviderByIdentifier(args: GetIdentityProviderByIdentifierCommandInput, cb: (err: any, data?: GetIdentityProviderByIdentifierCommandOutput) => void): void;
|
|
464
466
|
getIdentityProviderByIdentifier(args: GetIdentityProviderByIdentifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIdentityProviderByIdentifierCommandOutput) => void): void;
|
|
467
|
+
/**
|
|
468
|
+
* @see {@link GetLogDeliveryConfigurationCommand}
|
|
469
|
+
*/
|
|
470
|
+
getLogDeliveryConfiguration(args: GetLogDeliveryConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetLogDeliveryConfigurationCommandOutput>;
|
|
471
|
+
getLogDeliveryConfiguration(args: GetLogDeliveryConfigurationCommandInput, cb: (err: any, data?: GetLogDeliveryConfigurationCommandOutput) => void): void;
|
|
472
|
+
getLogDeliveryConfiguration(args: GetLogDeliveryConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLogDeliveryConfigurationCommandOutput) => void): void;
|
|
465
473
|
/**
|
|
466
474
|
* @see {@link GetSigningCertificateCommand}
|
|
467
475
|
*/
|
|
@@ -582,6 +590,12 @@ export interface CognitoIdentityProvider {
|
|
|
582
590
|
revokeToken(args: RevokeTokenCommandInput, options?: __HttpHandlerOptions): Promise<RevokeTokenCommandOutput>;
|
|
583
591
|
revokeToken(args: RevokeTokenCommandInput, cb: (err: any, data?: RevokeTokenCommandOutput) => void): void;
|
|
584
592
|
revokeToken(args: RevokeTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeTokenCommandOutput) => void): void;
|
|
593
|
+
/**
|
|
594
|
+
* @see {@link SetLogDeliveryConfigurationCommand}
|
|
595
|
+
*/
|
|
596
|
+
setLogDeliveryConfiguration(args: SetLogDeliveryConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<SetLogDeliveryConfigurationCommandOutput>;
|
|
597
|
+
setLogDeliveryConfiguration(args: SetLogDeliveryConfigurationCommandInput, cb: (err: any, data?: SetLogDeliveryConfigurationCommandOutput) => void): void;
|
|
598
|
+
setLogDeliveryConfiguration(args: SetLogDeliveryConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetLogDeliveryConfigurationCommandOutput) => void): void;
|
|
585
599
|
/**
|
|
586
600
|
* @see {@link SetRiskConfigurationCommand}
|
|
587
601
|
*/
|
|
@@ -711,12 +725,73 @@ export interface CognitoIdentityProvider {
|
|
|
711
725
|
}
|
|
712
726
|
/**
|
|
713
727
|
* @public
|
|
714
|
-
* <p>
|
|
715
|
-
* users.
|
|
716
|
-
*
|
|
717
|
-
*
|
|
718
|
-
* <p>
|
|
719
|
-
*
|
|
728
|
+
* <p>With the Amazon Cognito user pools API, you can set up user pools and app clients, and
|
|
729
|
+
* authenticate users. To authenticate users from third-party identity providers (IdPs) in
|
|
730
|
+
* this API, you can <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html">link IdP users to native user profiles</a>. Learn more
|
|
731
|
+
* about the authentication and authorization of federated users in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
|
|
732
|
+
* <p>This API reference provides detailed information about API operations and object types
|
|
733
|
+
* in Amazon Cognito. At the bottom of the page for each API operation and object, under
|
|
734
|
+
* <i>See Also</i>, you can learn how to use it in an Amazon Web Services SDK in the
|
|
735
|
+
* language of your choice.</p>
|
|
736
|
+
* <p>Along with resource management operations, the Amazon Cognito user pools API includes classes
|
|
737
|
+
* of operations and authorization models for client-side and server-side user operations.
|
|
738
|
+
* For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a> in the
|
|
739
|
+
* <i>Amazon Cognito Developer Guide</i>.</p>
|
|
740
|
+
* <p>You can also start reading about the <code>CognitoIdentityProvider</code> client in
|
|
741
|
+
* the following SDK guides.</p>
|
|
742
|
+
* <ul>
|
|
743
|
+
* <li>
|
|
744
|
+
* <p>
|
|
745
|
+
* <a href="https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/index.html#cli-aws-cognito-idp">Amazon Web Services
|
|
746
|
+
* Command Line Interface</a>
|
|
747
|
+
* </p>
|
|
748
|
+
* </li>
|
|
749
|
+
* <li>
|
|
750
|
+
* <p>
|
|
751
|
+
* <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CognitoIdentityProvider/TCognitoIdentityProviderClient.html">Amazon Web Services SDK for .NET</a>
|
|
752
|
+
* </p>
|
|
753
|
+
* </li>
|
|
754
|
+
* <li>
|
|
755
|
+
* <p>
|
|
756
|
+
* <a href="https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-cognito-idp/html/class_aws_1_1_cognito_identity_provider_1_1_cognito_identity_provider_client.html">Amazon Web Services SDK for C++</a>
|
|
757
|
+
* </p>
|
|
758
|
+
* </li>
|
|
759
|
+
* <li>
|
|
760
|
+
* <p>
|
|
761
|
+
* <a href="https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentityprovider/#CognitoIdentityProvider">Amazon Web Services SDK for Go</a>
|
|
762
|
+
* </p>
|
|
763
|
+
* </li>
|
|
764
|
+
* <li>
|
|
765
|
+
* <p>
|
|
766
|
+
* <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/cognitoidentityprovider/CognitoIdentityProviderClient.html">Amazon Web Services SDK for Java V2</a>
|
|
767
|
+
* </p>
|
|
768
|
+
* </li>
|
|
769
|
+
* <li>
|
|
770
|
+
* <p>
|
|
771
|
+
* <a href="https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CognitoIdentityServiceProvider.html">Amazon Web Services
|
|
772
|
+
* SDK for JavaScript</a>
|
|
773
|
+
* </p>
|
|
774
|
+
* </li>
|
|
775
|
+
* <li>
|
|
776
|
+
* <p>
|
|
777
|
+
* <a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html">Amazon Web Services SDK for PHP
|
|
778
|
+
* V3</a>
|
|
779
|
+
* </p>
|
|
780
|
+
* </li>
|
|
781
|
+
* <li>
|
|
782
|
+
* <p>
|
|
783
|
+
* <a href="https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html">Amazon Web Services SDK for Python</a>
|
|
784
|
+
* </p>
|
|
785
|
+
* </li>
|
|
786
|
+
* <li>
|
|
787
|
+
* <p>
|
|
788
|
+
* <a href="https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html">Amazon Web Services SDK
|
|
789
|
+
* for Ruby V3</a>
|
|
790
|
+
* </p>
|
|
791
|
+
* </li>
|
|
792
|
+
* </ul>
|
|
793
|
+
* <p>To get started with an Amazon Web Services SDK, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>. For example actions and scenarios, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/service_code_examples_cognito-identity-provider.html">Code examples for Amazon Cognito Identity Provider using Amazon Web Services
|
|
794
|
+
* SDKs</a>.</p>
|
|
720
795
|
*/
|
|
721
796
|
export declare class CognitoIdentityProvider extends CognitoIdentityProviderClient implements CognitoIdentityProvider {
|
|
722
797
|
}
|
|
@@ -68,6 +68,7 @@ import { GetCSVHeaderCommandInput, GetCSVHeaderCommandOutput } from "./commands/
|
|
|
68
68
|
import { GetDeviceCommandInput, GetDeviceCommandOutput } from "./commands/GetDeviceCommand";
|
|
69
69
|
import { GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
|
|
70
70
|
import { GetIdentityProviderByIdentifierCommandInput, GetIdentityProviderByIdentifierCommandOutput } from "./commands/GetIdentityProviderByIdentifierCommand";
|
|
71
|
+
import { GetLogDeliveryConfigurationCommandInput, GetLogDeliveryConfigurationCommandOutput } from "./commands/GetLogDeliveryConfigurationCommand";
|
|
71
72
|
import { GetSigningCertificateCommandInput, GetSigningCertificateCommandOutput } from "./commands/GetSigningCertificateCommand";
|
|
72
73
|
import { GetUICustomizationCommandInput, GetUICustomizationCommandOutput } from "./commands/GetUICustomizationCommand";
|
|
73
74
|
import { GetUserAttributeVerificationCodeCommandInput, GetUserAttributeVerificationCodeCommandOutput } from "./commands/GetUserAttributeVerificationCodeCommand";
|
|
@@ -88,6 +89,7 @@ import { ListUsersInGroupCommandInput, ListUsersInGroupCommandOutput } from "./c
|
|
|
88
89
|
import { ResendConfirmationCodeCommandInput, ResendConfirmationCodeCommandOutput } from "./commands/ResendConfirmationCodeCommand";
|
|
89
90
|
import { RespondToAuthChallengeCommandInput, RespondToAuthChallengeCommandOutput } from "./commands/RespondToAuthChallengeCommand";
|
|
90
91
|
import { RevokeTokenCommandInput, RevokeTokenCommandOutput } from "./commands/RevokeTokenCommand";
|
|
92
|
+
import { SetLogDeliveryConfigurationCommandInput, SetLogDeliveryConfigurationCommandOutput } from "./commands/SetLogDeliveryConfigurationCommand";
|
|
91
93
|
import { SetRiskConfigurationCommandInput, SetRiskConfigurationCommandOutput } from "./commands/SetRiskConfigurationCommand";
|
|
92
94
|
import { SetUICustomizationCommandInput, SetUICustomizationCommandOutput } from "./commands/SetUICustomizationCommand";
|
|
93
95
|
import { SetUserMFAPreferenceCommandInput, SetUserMFAPreferenceCommandOutput } from "./commands/SetUserMFAPreferenceCommand";
|
|
@@ -114,11 +116,11 @@ export { __Client };
|
|
|
114
116
|
/**
|
|
115
117
|
* @public
|
|
116
118
|
*/
|
|
117
|
-
export type ServiceInputTypes = AddCustomAttributesCommandInput | AdminAddUserToGroupCommandInput | AdminConfirmSignUpCommandInput | AdminCreateUserCommandInput | AdminDeleteUserAttributesCommandInput | AdminDeleteUserCommandInput | AdminDisableProviderForUserCommandInput | AdminDisableUserCommandInput | AdminEnableUserCommandInput | AdminForgetDeviceCommandInput | AdminGetDeviceCommandInput | AdminGetUserCommandInput | AdminInitiateAuthCommandInput | AdminLinkProviderForUserCommandInput | AdminListDevicesCommandInput | AdminListGroupsForUserCommandInput | AdminListUserAuthEventsCommandInput | AdminRemoveUserFromGroupCommandInput | AdminResetUserPasswordCommandInput | AdminRespondToAuthChallengeCommandInput | AdminSetUserMFAPreferenceCommandInput | AdminSetUserPasswordCommandInput | AdminSetUserSettingsCommandInput | AdminUpdateAuthEventFeedbackCommandInput | AdminUpdateDeviceStatusCommandInput | AdminUpdateUserAttributesCommandInput | AdminUserGlobalSignOutCommandInput | AssociateSoftwareTokenCommandInput | ChangePasswordCommandInput | ConfirmDeviceCommandInput | ConfirmForgotPasswordCommandInput | ConfirmSignUpCommandInput | CreateGroupCommandInput | CreateIdentityProviderCommandInput | CreateResourceServerCommandInput | CreateUserImportJobCommandInput | CreateUserPoolClientCommandInput | CreateUserPoolCommandInput | CreateUserPoolDomainCommandInput | DeleteGroupCommandInput | DeleteIdentityProviderCommandInput | DeleteResourceServerCommandInput | DeleteUserAttributesCommandInput | DeleteUserCommandInput | DeleteUserPoolClientCommandInput | DeleteUserPoolCommandInput | DeleteUserPoolDomainCommandInput | DescribeIdentityProviderCommandInput | DescribeResourceServerCommandInput | DescribeRiskConfigurationCommandInput | DescribeUserImportJobCommandInput | DescribeUserPoolClientCommandInput | DescribeUserPoolCommandInput | DescribeUserPoolDomainCommandInput | ForgetDeviceCommandInput | ForgotPasswordCommandInput | GetCSVHeaderCommandInput | GetDeviceCommandInput | GetGroupCommandInput | GetIdentityProviderByIdentifierCommandInput | GetSigningCertificateCommandInput | GetUICustomizationCommandInput | GetUserAttributeVerificationCodeCommandInput | GetUserCommandInput | GetUserPoolMfaConfigCommandInput | GlobalSignOutCommandInput | InitiateAuthCommandInput | ListDevicesCommandInput | ListGroupsCommandInput | ListIdentityProvidersCommandInput | ListResourceServersCommandInput | ListTagsForResourceCommandInput | ListUserImportJobsCommandInput | ListUserPoolClientsCommandInput | ListUserPoolsCommandInput | ListUsersCommandInput | ListUsersInGroupCommandInput | ResendConfirmationCodeCommandInput | RespondToAuthChallengeCommandInput | RevokeTokenCommandInput | SetRiskConfigurationCommandInput | SetUICustomizationCommandInput | SetUserMFAPreferenceCommandInput | SetUserPoolMfaConfigCommandInput | SetUserSettingsCommandInput | SignUpCommandInput | StartUserImportJobCommandInput | StopUserImportJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAuthEventFeedbackCommandInput | UpdateDeviceStatusCommandInput | UpdateGroupCommandInput | UpdateIdentityProviderCommandInput | UpdateResourceServerCommandInput | UpdateUserAttributesCommandInput | UpdateUserPoolClientCommandInput | UpdateUserPoolCommandInput | UpdateUserPoolDomainCommandInput | VerifySoftwareTokenCommandInput | VerifyUserAttributeCommandInput;
|
|
119
|
+
export type ServiceInputTypes = AddCustomAttributesCommandInput | AdminAddUserToGroupCommandInput | AdminConfirmSignUpCommandInput | AdminCreateUserCommandInput | AdminDeleteUserAttributesCommandInput | AdminDeleteUserCommandInput | AdminDisableProviderForUserCommandInput | AdminDisableUserCommandInput | AdminEnableUserCommandInput | AdminForgetDeviceCommandInput | AdminGetDeviceCommandInput | AdminGetUserCommandInput | AdminInitiateAuthCommandInput | AdminLinkProviderForUserCommandInput | AdminListDevicesCommandInput | AdminListGroupsForUserCommandInput | AdminListUserAuthEventsCommandInput | AdminRemoveUserFromGroupCommandInput | AdminResetUserPasswordCommandInput | AdminRespondToAuthChallengeCommandInput | AdminSetUserMFAPreferenceCommandInput | AdminSetUserPasswordCommandInput | AdminSetUserSettingsCommandInput | AdminUpdateAuthEventFeedbackCommandInput | AdminUpdateDeviceStatusCommandInput | AdminUpdateUserAttributesCommandInput | AdminUserGlobalSignOutCommandInput | AssociateSoftwareTokenCommandInput | ChangePasswordCommandInput | ConfirmDeviceCommandInput | ConfirmForgotPasswordCommandInput | ConfirmSignUpCommandInput | CreateGroupCommandInput | CreateIdentityProviderCommandInput | CreateResourceServerCommandInput | CreateUserImportJobCommandInput | CreateUserPoolClientCommandInput | CreateUserPoolCommandInput | CreateUserPoolDomainCommandInput | DeleteGroupCommandInput | DeleteIdentityProviderCommandInput | DeleteResourceServerCommandInput | DeleteUserAttributesCommandInput | DeleteUserCommandInput | DeleteUserPoolClientCommandInput | DeleteUserPoolCommandInput | DeleteUserPoolDomainCommandInput | DescribeIdentityProviderCommandInput | DescribeResourceServerCommandInput | DescribeRiskConfigurationCommandInput | DescribeUserImportJobCommandInput | DescribeUserPoolClientCommandInput | DescribeUserPoolCommandInput | DescribeUserPoolDomainCommandInput | ForgetDeviceCommandInput | ForgotPasswordCommandInput | GetCSVHeaderCommandInput | GetDeviceCommandInput | GetGroupCommandInput | GetIdentityProviderByIdentifierCommandInput | GetLogDeliveryConfigurationCommandInput | GetSigningCertificateCommandInput | GetUICustomizationCommandInput | GetUserAttributeVerificationCodeCommandInput | GetUserCommandInput | GetUserPoolMfaConfigCommandInput | GlobalSignOutCommandInput | InitiateAuthCommandInput | ListDevicesCommandInput | ListGroupsCommandInput | ListIdentityProvidersCommandInput | ListResourceServersCommandInput | ListTagsForResourceCommandInput | ListUserImportJobsCommandInput | ListUserPoolClientsCommandInput | ListUserPoolsCommandInput | ListUsersCommandInput | ListUsersInGroupCommandInput | ResendConfirmationCodeCommandInput | RespondToAuthChallengeCommandInput | RevokeTokenCommandInput | SetLogDeliveryConfigurationCommandInput | SetRiskConfigurationCommandInput | SetUICustomizationCommandInput | SetUserMFAPreferenceCommandInput | SetUserPoolMfaConfigCommandInput | SetUserSettingsCommandInput | SignUpCommandInput | StartUserImportJobCommandInput | StopUserImportJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAuthEventFeedbackCommandInput | UpdateDeviceStatusCommandInput | UpdateGroupCommandInput | UpdateIdentityProviderCommandInput | UpdateResourceServerCommandInput | UpdateUserAttributesCommandInput | UpdateUserPoolClientCommandInput | UpdateUserPoolCommandInput | UpdateUserPoolDomainCommandInput | VerifySoftwareTokenCommandInput | VerifyUserAttributeCommandInput;
|
|
118
120
|
/**
|
|
119
121
|
* @public
|
|
120
122
|
*/
|
|
121
|
-
export type ServiceOutputTypes = AddCustomAttributesCommandOutput | AdminAddUserToGroupCommandOutput | AdminConfirmSignUpCommandOutput | AdminCreateUserCommandOutput | AdminDeleteUserAttributesCommandOutput | AdminDeleteUserCommandOutput | AdminDisableProviderForUserCommandOutput | AdminDisableUserCommandOutput | AdminEnableUserCommandOutput | AdminForgetDeviceCommandOutput | AdminGetDeviceCommandOutput | AdminGetUserCommandOutput | AdminInitiateAuthCommandOutput | AdminLinkProviderForUserCommandOutput | AdminListDevicesCommandOutput | AdminListGroupsForUserCommandOutput | AdminListUserAuthEventsCommandOutput | AdminRemoveUserFromGroupCommandOutput | AdminResetUserPasswordCommandOutput | AdminRespondToAuthChallengeCommandOutput | AdminSetUserMFAPreferenceCommandOutput | AdminSetUserPasswordCommandOutput | AdminSetUserSettingsCommandOutput | AdminUpdateAuthEventFeedbackCommandOutput | AdminUpdateDeviceStatusCommandOutput | AdminUpdateUserAttributesCommandOutput | AdminUserGlobalSignOutCommandOutput | AssociateSoftwareTokenCommandOutput | ChangePasswordCommandOutput | ConfirmDeviceCommandOutput | ConfirmForgotPasswordCommandOutput | ConfirmSignUpCommandOutput | CreateGroupCommandOutput | CreateIdentityProviderCommandOutput | CreateResourceServerCommandOutput | CreateUserImportJobCommandOutput | CreateUserPoolClientCommandOutput | CreateUserPoolCommandOutput | CreateUserPoolDomainCommandOutput | DeleteGroupCommandOutput | DeleteIdentityProviderCommandOutput | DeleteResourceServerCommandOutput | DeleteUserAttributesCommandOutput | DeleteUserCommandOutput | DeleteUserPoolClientCommandOutput | DeleteUserPoolCommandOutput | DeleteUserPoolDomainCommandOutput | DescribeIdentityProviderCommandOutput | DescribeResourceServerCommandOutput | DescribeRiskConfigurationCommandOutput | DescribeUserImportJobCommandOutput | DescribeUserPoolClientCommandOutput | DescribeUserPoolCommandOutput | DescribeUserPoolDomainCommandOutput | ForgetDeviceCommandOutput | ForgotPasswordCommandOutput | GetCSVHeaderCommandOutput | GetDeviceCommandOutput | GetGroupCommandOutput | GetIdentityProviderByIdentifierCommandOutput | GetSigningCertificateCommandOutput | GetUICustomizationCommandOutput | GetUserAttributeVerificationCodeCommandOutput | GetUserCommandOutput | GetUserPoolMfaConfigCommandOutput | GlobalSignOutCommandOutput | InitiateAuthCommandOutput | ListDevicesCommandOutput | ListGroupsCommandOutput | ListIdentityProvidersCommandOutput | ListResourceServersCommandOutput | ListTagsForResourceCommandOutput | ListUserImportJobsCommandOutput | ListUserPoolClientsCommandOutput | ListUserPoolsCommandOutput | ListUsersCommandOutput | ListUsersInGroupCommandOutput | ResendConfirmationCodeCommandOutput | RespondToAuthChallengeCommandOutput | RevokeTokenCommandOutput | SetRiskConfigurationCommandOutput | SetUICustomizationCommandOutput | SetUserMFAPreferenceCommandOutput | SetUserPoolMfaConfigCommandOutput | SetUserSettingsCommandOutput | SignUpCommandOutput | StartUserImportJobCommandOutput | StopUserImportJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAuthEventFeedbackCommandOutput | UpdateDeviceStatusCommandOutput | UpdateGroupCommandOutput | UpdateIdentityProviderCommandOutput | UpdateResourceServerCommandOutput | UpdateUserAttributesCommandOutput | UpdateUserPoolClientCommandOutput | UpdateUserPoolCommandOutput | UpdateUserPoolDomainCommandOutput | VerifySoftwareTokenCommandOutput | VerifyUserAttributeCommandOutput;
|
|
123
|
+
export type ServiceOutputTypes = AddCustomAttributesCommandOutput | AdminAddUserToGroupCommandOutput | AdminConfirmSignUpCommandOutput | AdminCreateUserCommandOutput | AdminDeleteUserAttributesCommandOutput | AdminDeleteUserCommandOutput | AdminDisableProviderForUserCommandOutput | AdminDisableUserCommandOutput | AdminEnableUserCommandOutput | AdminForgetDeviceCommandOutput | AdminGetDeviceCommandOutput | AdminGetUserCommandOutput | AdminInitiateAuthCommandOutput | AdminLinkProviderForUserCommandOutput | AdminListDevicesCommandOutput | AdminListGroupsForUserCommandOutput | AdminListUserAuthEventsCommandOutput | AdminRemoveUserFromGroupCommandOutput | AdminResetUserPasswordCommandOutput | AdminRespondToAuthChallengeCommandOutput | AdminSetUserMFAPreferenceCommandOutput | AdminSetUserPasswordCommandOutput | AdminSetUserSettingsCommandOutput | AdminUpdateAuthEventFeedbackCommandOutput | AdminUpdateDeviceStatusCommandOutput | AdminUpdateUserAttributesCommandOutput | AdminUserGlobalSignOutCommandOutput | AssociateSoftwareTokenCommandOutput | ChangePasswordCommandOutput | ConfirmDeviceCommandOutput | ConfirmForgotPasswordCommandOutput | ConfirmSignUpCommandOutput | CreateGroupCommandOutput | CreateIdentityProviderCommandOutput | CreateResourceServerCommandOutput | CreateUserImportJobCommandOutput | CreateUserPoolClientCommandOutput | CreateUserPoolCommandOutput | CreateUserPoolDomainCommandOutput | DeleteGroupCommandOutput | DeleteIdentityProviderCommandOutput | DeleteResourceServerCommandOutput | DeleteUserAttributesCommandOutput | DeleteUserCommandOutput | DeleteUserPoolClientCommandOutput | DeleteUserPoolCommandOutput | DeleteUserPoolDomainCommandOutput | DescribeIdentityProviderCommandOutput | DescribeResourceServerCommandOutput | DescribeRiskConfigurationCommandOutput | DescribeUserImportJobCommandOutput | DescribeUserPoolClientCommandOutput | DescribeUserPoolCommandOutput | DescribeUserPoolDomainCommandOutput | ForgetDeviceCommandOutput | ForgotPasswordCommandOutput | GetCSVHeaderCommandOutput | GetDeviceCommandOutput | GetGroupCommandOutput | GetIdentityProviderByIdentifierCommandOutput | GetLogDeliveryConfigurationCommandOutput | GetSigningCertificateCommandOutput | GetUICustomizationCommandOutput | GetUserAttributeVerificationCodeCommandOutput | GetUserCommandOutput | GetUserPoolMfaConfigCommandOutput | GlobalSignOutCommandOutput | InitiateAuthCommandOutput | ListDevicesCommandOutput | ListGroupsCommandOutput | ListIdentityProvidersCommandOutput | ListResourceServersCommandOutput | ListTagsForResourceCommandOutput | ListUserImportJobsCommandOutput | ListUserPoolClientsCommandOutput | ListUserPoolsCommandOutput | ListUsersCommandOutput | ListUsersInGroupCommandOutput | ResendConfirmationCodeCommandOutput | RespondToAuthChallengeCommandOutput | RevokeTokenCommandOutput | SetLogDeliveryConfigurationCommandOutput | SetRiskConfigurationCommandOutput | SetUICustomizationCommandOutput | SetUserMFAPreferenceCommandOutput | SetUserPoolMfaConfigCommandOutput | SetUserSettingsCommandOutput | SignUpCommandOutput | StartUserImportJobCommandOutput | StopUserImportJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAuthEventFeedbackCommandOutput | UpdateDeviceStatusCommandOutput | UpdateGroupCommandOutput | UpdateIdentityProviderCommandOutput | UpdateResourceServerCommandOutput | UpdateUserAttributesCommandOutput | UpdateUserPoolClientCommandOutput | UpdateUserPoolCommandOutput | UpdateUserPoolDomainCommandOutput | VerifySoftwareTokenCommandOutput | VerifyUserAttributeCommandOutput;
|
|
122
124
|
/**
|
|
123
125
|
* @public
|
|
124
126
|
*/
|
|
@@ -246,12 +248,73 @@ export interface CognitoIdentityProviderClientResolvedConfig extends CognitoIden
|
|
|
246
248
|
}
|
|
247
249
|
/**
|
|
248
250
|
* @public
|
|
249
|
-
* <p>
|
|
250
|
-
* users.
|
|
251
|
-
*
|
|
252
|
-
*
|
|
253
|
-
* <p>
|
|
254
|
-
*
|
|
251
|
+
* <p>With the Amazon Cognito user pools API, you can set up user pools and app clients, and
|
|
252
|
+
* authenticate users. To authenticate users from third-party identity providers (IdPs) in
|
|
253
|
+
* this API, you can <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html">link IdP users to native user profiles</a>. Learn more
|
|
254
|
+
* about the authentication and authorization of federated users in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
|
|
255
|
+
* <p>This API reference provides detailed information about API operations and object types
|
|
256
|
+
* in Amazon Cognito. At the bottom of the page for each API operation and object, under
|
|
257
|
+
* <i>See Also</i>, you can learn how to use it in an Amazon Web Services SDK in the
|
|
258
|
+
* language of your choice.</p>
|
|
259
|
+
* <p>Along with resource management operations, the Amazon Cognito user pools API includes classes
|
|
260
|
+
* of operations and authorization models for client-side and server-side user operations.
|
|
261
|
+
* For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a> in the
|
|
262
|
+
* <i>Amazon Cognito Developer Guide</i>.</p>
|
|
263
|
+
* <p>You can also start reading about the <code>CognitoIdentityProvider</code> client in
|
|
264
|
+
* the following SDK guides.</p>
|
|
265
|
+
* <ul>
|
|
266
|
+
* <li>
|
|
267
|
+
* <p>
|
|
268
|
+
* <a href="https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/index.html#cli-aws-cognito-idp">Amazon Web Services
|
|
269
|
+
* Command Line Interface</a>
|
|
270
|
+
* </p>
|
|
271
|
+
* </li>
|
|
272
|
+
* <li>
|
|
273
|
+
* <p>
|
|
274
|
+
* <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CognitoIdentityProvider/TCognitoIdentityProviderClient.html">Amazon Web Services SDK for .NET</a>
|
|
275
|
+
* </p>
|
|
276
|
+
* </li>
|
|
277
|
+
* <li>
|
|
278
|
+
* <p>
|
|
279
|
+
* <a href="https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-cognito-idp/html/class_aws_1_1_cognito_identity_provider_1_1_cognito_identity_provider_client.html">Amazon Web Services SDK for C++</a>
|
|
280
|
+
* </p>
|
|
281
|
+
* </li>
|
|
282
|
+
* <li>
|
|
283
|
+
* <p>
|
|
284
|
+
* <a href="https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentityprovider/#CognitoIdentityProvider">Amazon Web Services SDK for Go</a>
|
|
285
|
+
* </p>
|
|
286
|
+
* </li>
|
|
287
|
+
* <li>
|
|
288
|
+
* <p>
|
|
289
|
+
* <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/cognitoidentityprovider/CognitoIdentityProviderClient.html">Amazon Web Services SDK for Java V2</a>
|
|
290
|
+
* </p>
|
|
291
|
+
* </li>
|
|
292
|
+
* <li>
|
|
293
|
+
* <p>
|
|
294
|
+
* <a href="https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CognitoIdentityServiceProvider.html">Amazon Web Services
|
|
295
|
+
* SDK for JavaScript</a>
|
|
296
|
+
* </p>
|
|
297
|
+
* </li>
|
|
298
|
+
* <li>
|
|
299
|
+
* <p>
|
|
300
|
+
* <a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html">Amazon Web Services SDK for PHP
|
|
301
|
+
* V3</a>
|
|
302
|
+
* </p>
|
|
303
|
+
* </li>
|
|
304
|
+
* <li>
|
|
305
|
+
* <p>
|
|
306
|
+
* <a href="https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html">Amazon Web Services SDK for Python</a>
|
|
307
|
+
* </p>
|
|
308
|
+
* </li>
|
|
309
|
+
* <li>
|
|
310
|
+
* <p>
|
|
311
|
+
* <a href="https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html">Amazon Web Services SDK
|
|
312
|
+
* for Ruby V3</a>
|
|
313
|
+
* </p>
|
|
314
|
+
* </li>
|
|
315
|
+
* </ul>
|
|
316
|
+
* <p>To get started with an Amazon Web Services SDK, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>. For example actions and scenarios, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/service_code_examples_cognito-identity-provider.html">Code examples for Amazon Cognito Identity Provider using Amazon Web Services
|
|
317
|
+
* SDKs</a>.</p>
|
|
255
318
|
*/
|
|
256
319
|
export declare class CognitoIdentityProviderClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CognitoIdentityProviderClientResolvedConfig> {
|
|
257
320
|
/**
|
|
@@ -24,6 +24,26 @@ export interface AddCustomAttributesCommandOutput extends AddCustomAttributesRes
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Adds additional user attributes to the user pool schema.</p>
|
|
27
|
+
* <note>
|
|
28
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
29
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
30
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
31
|
+
* <p class="title">
|
|
32
|
+
* <b>Learn more</b>
|
|
33
|
+
* </p>
|
|
34
|
+
* <ul>
|
|
35
|
+
* <li>
|
|
36
|
+
* <p>
|
|
37
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
38
|
+
* </p>
|
|
39
|
+
* </li>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>
|
|
42
|
+
* <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>
|
|
43
|
+
* </p>
|
|
44
|
+
* </li>
|
|
45
|
+
* </ul>
|
|
46
|
+
* </note>
|
|
27
47
|
* @example
|
|
28
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
49
|
* ```javascript
|
|
@@ -24,7 +24,26 @@ export interface AdminAddUserToGroupCommandOutput extends __MetadataBearer {
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Adds the specified user to the specified group.</p>
|
|
27
|
-
* <
|
|
27
|
+
* <note>
|
|
28
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
29
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
30
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
31
|
+
* <p class="title">
|
|
32
|
+
* <b>Learn more</b>
|
|
33
|
+
* </p>
|
|
34
|
+
* <ul>
|
|
35
|
+
* <li>
|
|
36
|
+
* <p>
|
|
37
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
38
|
+
* </p>
|
|
39
|
+
* </li>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>
|
|
42
|
+
* <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>
|
|
43
|
+
* </p>
|
|
44
|
+
* </li>
|
|
45
|
+
* </ul>
|
|
46
|
+
* </note>
|
|
28
47
|
* @example
|
|
29
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
49
|
* ```javascript
|
|
@@ -25,7 +25,26 @@ export interface AdminConfirmSignUpCommandOutput extends AdminConfirmSignUpRespo
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Confirms user registration as an admin without using a confirmation code. Works on any
|
|
27
27
|
* user.</p>
|
|
28
|
-
* <
|
|
28
|
+
* <note>
|
|
29
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
30
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
31
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
32
|
+
* <p class="title">
|
|
33
|
+
* <b>Learn more</b>
|
|
34
|
+
* </p>
|
|
35
|
+
* <ul>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>
|
|
38
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
39
|
+
* </p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>
|
|
43
|
+
* <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>
|
|
44
|
+
* </p>
|
|
45
|
+
* </li>
|
|
46
|
+
* </ul>
|
|
47
|
+
* </note>
|
|
29
48
|
* @example
|
|
30
49
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
50
|
* ```javascript
|
|
@@ -40,7 +40,7 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
|
|
|
40
40
|
* mode</a>
|
|
41
41
|
* </i>, you can send messages only to verified phone
|
|
42
42
|
* numbers. After you test your app while in the sandbox environment, you can move out
|
|
43
|
-
* of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/
|
|
43
|
+
* of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito
|
|
44
44
|
* Developer Guide</i>.</p>
|
|
45
45
|
* </note>
|
|
46
46
|
* <p>This message is based on a template that you configured in your call to create or
|
|
@@ -50,8 +50,26 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
|
|
|
50
50
|
* for the <code>MessageAction</code> parameter, and Amazon Cognito won't send any email. </p>
|
|
51
51
|
* <p>In either case, the user will be in the <code>FORCE_CHANGE_PASSWORD</code> state until
|
|
52
52
|
* they sign in and change their password.</p>
|
|
53
|
-
* <
|
|
54
|
-
* <
|
|
53
|
+
* <note>
|
|
54
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
55
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
56
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
57
|
+
* <p class="title">
|
|
58
|
+
* <b>Learn more</b>
|
|
59
|
+
* </p>
|
|
60
|
+
* <ul>
|
|
61
|
+
* <li>
|
|
62
|
+
* <p>
|
|
63
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
64
|
+
* </p>
|
|
65
|
+
* </li>
|
|
66
|
+
* <li>
|
|
67
|
+
* <p>
|
|
68
|
+
* <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>
|
|
69
|
+
* </p>
|
|
70
|
+
* </li>
|
|
71
|
+
* </ul>
|
|
72
|
+
* </note>
|
|
55
73
|
* @example
|
|
56
74
|
* Use a bare-bones client and the command you need to make an API call.
|
|
57
75
|
* ```javascript
|
|
@@ -139,7 +157,7 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _
|
|
|
139
157
|
* @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
|
|
140
158
|
* <p>This exception is thrown when the trust relationship is not valid for the role
|
|
141
159
|
* provided for SMS configuration. This can happen if you don't trust
|
|
142
|
-
*
|
|
160
|
+
* <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
|
|
143
161
|
* not match what is provided in the SMS configuration for the user pool.</p>
|
|
144
162
|
*
|
|
145
163
|
* @throws {@link NotAuthorizedException} (client fault)
|
|
@@ -25,7 +25,26 @@ export interface AdminDeleteUserAttributesCommandOutput extends AdminDeleteUserA
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Deletes the user attributes in a user pool as an administrator. Works on any
|
|
27
27
|
* user.</p>
|
|
28
|
-
* <
|
|
28
|
+
* <note>
|
|
29
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
30
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
31
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
32
|
+
* <p class="title">
|
|
33
|
+
* <b>Learn more</b>
|
|
34
|
+
* </p>
|
|
35
|
+
* <ul>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>
|
|
38
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
39
|
+
* </p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>
|
|
43
|
+
* <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>
|
|
44
|
+
* </p>
|
|
45
|
+
* </li>
|
|
46
|
+
* </ul>
|
|
47
|
+
* </note>
|
|
29
48
|
* @example
|
|
30
49
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
50
|
* ```javascript
|
|
@@ -24,7 +24,26 @@ export interface AdminDeleteUserCommandOutput extends __MetadataBearer {
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Deletes a user as an administrator. Works on any user.</p>
|
|
27
|
-
* <
|
|
27
|
+
* <note>
|
|
28
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
29
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
30
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
31
|
+
* <p class="title">
|
|
32
|
+
* <b>Learn more</b>
|
|
33
|
+
* </p>
|
|
34
|
+
* <ul>
|
|
35
|
+
* <li>
|
|
36
|
+
* <p>
|
|
37
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
38
|
+
* </p>
|
|
39
|
+
* </li>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>
|
|
42
|
+
* <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>
|
|
43
|
+
* </p>
|
|
44
|
+
* </li>
|
|
45
|
+
* </ul>
|
|
46
|
+
* </note>
|
|
28
47
|
* @example
|
|
29
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
49
|
* ```javascript
|
|
@@ -30,8 +30,6 @@ export interface AdminDisableProviderForUserCommandOutput extends AdminDisablePr
|
|
|
30
30
|
* user is removed. When the external user signs in again, and the user is no longer
|
|
31
31
|
* attached to the previously linked <code>DestinationUser</code>, the user must create a
|
|
32
32
|
* new user account. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a>.</p>
|
|
33
|
-
* <p>This action is enabled only for admin access and requires developer
|
|
34
|
-
* credentials.</p>
|
|
35
33
|
* <p>The <code>ProviderName</code> must match the value specified when creating an IdP for
|
|
36
34
|
* the pool. </p>
|
|
37
35
|
* <p>To deactivate a native username + password user, the <code>ProviderName</code> value
|
|
@@ -51,6 +49,26 @@ export interface AdminDisableProviderForUserCommandOutput extends AdminDisablePr
|
|
|
51
49
|
* <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code> and
|
|
52
50
|
* <code>ProviderAttributeValue</code> must be the subject of the SAML
|
|
53
51
|
* assertion.</p>
|
|
52
|
+
* <note>
|
|
53
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
54
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
55
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
56
|
+
* <p class="title">
|
|
57
|
+
* <b>Learn more</b>
|
|
58
|
+
* </p>
|
|
59
|
+
* <ul>
|
|
60
|
+
* <li>
|
|
61
|
+
* <p>
|
|
62
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
63
|
+
* </p>
|
|
64
|
+
* </li>
|
|
65
|
+
* <li>
|
|
66
|
+
* <p>
|
|
67
|
+
* <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>
|
|
68
|
+
* </p>
|
|
69
|
+
* </li>
|
|
70
|
+
* </ul>
|
|
71
|
+
* </note>
|
|
54
72
|
* @example
|
|
55
73
|
* Use a bare-bones client and the command you need to make an API call.
|
|
56
74
|
* ```javascript
|
|
@@ -79,8 +97,8 @@ export interface AdminDisableProviderForUserCommandOutput extends AdminDisablePr
|
|
|
79
97
|
*
|
|
80
98
|
* @throws {@link AliasExistsException} (client fault)
|
|
81
99
|
* <p>This exception is thrown when a user tries to confirm the account with an email
|
|
82
|
-
* address or phone number that has already been supplied as an alias for a different
|
|
83
|
-
*
|
|
100
|
+
* address or phone number that has already been supplied as an alias for a different user
|
|
101
|
+
* profile. This exception indicates that an account with this email address or phone
|
|
84
102
|
* already exists in a user pool that you've configured to use email address or phone
|
|
85
103
|
* number as a sign-in alias.</p>
|
|
86
104
|
*
|