@aws-sdk/client-cognito-identity-provider 3.1119.0 → 3.1121.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 +21 -0
- package/dist-cjs/index.js +94 -13
- package/dist-es/CognitoIdentityProvider.js +6 -0
- package/dist-es/commands/AdminDeleteSoftwareTokenCommand.js +4 -0
- package/dist-es/commands/DescribeTermsByClientCommand.js +4 -0
- package/dist-es/commands/GetClientTokenCommand.js +4 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/errors.js +12 -12
- package/dist-es/schemas/schemas_0.js +56 -0
- package/dist-types/CognitoIdentityProvider.d.ts +21 -0
- package/dist-types/CognitoIdentityProviderClient.d.ts +5 -2
- package/dist-types/commands/AdminDeleteSoftwareTokenCommand.d.ts +122 -0
- package/dist-types/commands/DescribeTermsByClientCommand.d.ts +134 -0
- package/dist-types/commands/DescribeUserPoolDomainCommand.d.ts +6 -0
- package/dist-types/commands/GetClientTokenCommand.d.ts +144 -0
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +2 -1
- package/dist-types/commands/SetUserSettingsCommand.d.ts +1 -1
- package/dist-types/commands/SignUpCommand.d.ts +1 -1
- package/dist-types/commands/StartUserImportJobCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/errors.d.ts +12 -12
- package/dist-types/models/models_0.d.ts +147 -237
- package/dist-types/models/models_1.d.ts +233 -1
- package/dist-types/schemas/schemas_0.d.ts +10 -0
- package/dist-types/ts3.4/CognitoIdentityProvider.d.ts +51 -0
- package/dist-types/ts3.4/CognitoIdentityProviderClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/AdminDeleteSoftwareTokenCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeTermsByClientCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetClientTokenCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/SetUserPoolMfaConfigCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/SetUserSettingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SignUpCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartUserImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/errors.d.ts +5 -5
- package/dist-types/ts3.4/models/models_0.d.ts +27 -36
- package/dist-types/ts3.4/models/models_1.d.ts +43 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +10 -0
- package/package.json +1 -1
|
@@ -11,6 +11,7 @@ import type { AddUserPoolClientSecretCommandInput, AddUserPoolClientSecretComman
|
|
|
11
11
|
import type { AdminAddUserToGroupCommandInput, AdminAddUserToGroupCommandOutput } from "./commands/AdminAddUserToGroupCommand";
|
|
12
12
|
import type { AdminConfirmSignUpCommandInput, AdminConfirmSignUpCommandOutput } from "./commands/AdminConfirmSignUpCommand";
|
|
13
13
|
import type { AdminCreateUserCommandInput, AdminCreateUserCommandOutput } from "./commands/AdminCreateUserCommand";
|
|
14
|
+
import type { AdminDeleteSoftwareTokenCommandInput, AdminDeleteSoftwareTokenCommandOutput } from "./commands/AdminDeleteSoftwareTokenCommand";
|
|
14
15
|
import type { AdminDeleteUserAttributesCommandInput, AdminDeleteUserAttributesCommandOutput } from "./commands/AdminDeleteUserAttributesCommand";
|
|
15
16
|
import type { AdminDeleteUserCommandInput, AdminDeleteUserCommandOutput } from "./commands/AdminDeleteUserCommand";
|
|
16
17
|
import type { AdminDisableProviderForUserCommandInput, AdminDisableProviderForUserCommandOutput } from "./commands/AdminDisableProviderForUserCommand";
|
|
@@ -69,6 +70,7 @@ import type { DescribeManagedLoginBrandingByClientCommandInput, DescribeManagedL
|
|
|
69
70
|
import type { DescribeManagedLoginBrandingCommandInput, DescribeManagedLoginBrandingCommandOutput } from "./commands/DescribeManagedLoginBrandingCommand";
|
|
70
71
|
import type { DescribeResourceServerCommandInput, DescribeResourceServerCommandOutput } from "./commands/DescribeResourceServerCommand";
|
|
71
72
|
import type { DescribeRiskConfigurationCommandInput, DescribeRiskConfigurationCommandOutput } from "./commands/DescribeRiskConfigurationCommand";
|
|
73
|
+
import type { DescribeTermsByClientCommandInput, DescribeTermsByClientCommandOutput } from "./commands/DescribeTermsByClientCommand";
|
|
72
74
|
import type { DescribeTermsCommandInput, DescribeTermsCommandOutput } from "./commands/DescribeTermsCommand";
|
|
73
75
|
import type { DescribeUserImportJobCommandInput, DescribeUserImportJobCommandOutput } from "./commands/DescribeUserImportJobCommand";
|
|
74
76
|
import type { DescribeUserPoolClientCommandInput, DescribeUserPoolClientCommandOutput } from "./commands/DescribeUserPoolClientCommand";
|
|
@@ -76,6 +78,7 @@ import type { DescribeUserPoolCommandInput, DescribeUserPoolCommandOutput } from
|
|
|
76
78
|
import type { DescribeUserPoolDomainCommandInput, DescribeUserPoolDomainCommandOutput } from "./commands/DescribeUserPoolDomainCommand";
|
|
77
79
|
import type { ForgetDeviceCommandInput, ForgetDeviceCommandOutput } from "./commands/ForgetDeviceCommand";
|
|
78
80
|
import type { ForgotPasswordCommandInput, ForgotPasswordCommandOutput } from "./commands/ForgotPasswordCommand";
|
|
81
|
+
import type { GetClientTokenCommandInput, GetClientTokenCommandOutput } from "./commands/GetClientTokenCommand";
|
|
79
82
|
import type { GetCSVHeaderCommandInput, GetCSVHeaderCommandOutput } from "./commands/GetCSVHeaderCommand";
|
|
80
83
|
import type { GetDeviceCommandInput, GetDeviceCommandOutput } from "./commands/GetDeviceCommand";
|
|
81
84
|
import type { GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
|
|
@@ -141,11 +144,11 @@ export { __Client };
|
|
|
141
144
|
/**
|
|
142
145
|
* @public
|
|
143
146
|
*/
|
|
144
|
-
export type ServiceInputTypes = AddCustomAttributesCommandInput | AddUserPoolClientSecretCommandInput | AdminAddUserToGroupCommandInput | AdminConfirmSignUpCommandInput | AdminCreateUserCommandInput | AdminDeleteUserAttributesCommandInput | AdminDeleteUserCommandInput | AdminDisableProviderForUserCommandInput | AdminDisableUserCommandInput | AdminEnableUserCommandInput | AdminForgetDeviceCommandInput | AdminGetDeviceCommandInput | AdminGetUserAuthFactorsCommandInput | AdminGetUserCommandInput | AdminInitiateAuthCommandInput | AdminLinkProviderForUserCommandInput | AdminListDevicesCommandInput | AdminListGroupsForUserCommandInput | AdminListUserAuthEventsCommandInput | AdminRemoveUserFromGroupCommandInput | AdminResetUserPasswordCommandInput | AdminRespondToAuthChallengeCommandInput | AdminSetUserMFAPreferenceCommandInput | AdminSetUserPasswordCommandInput | AdminSetUserSettingsCommandInput | AdminUpdateAuthEventFeedbackCommandInput | AdminUpdateDeviceStatusCommandInput | AdminUpdateUserAttributesCommandInput | AdminUserGlobalSignOutCommandInput | AssociateSoftwareTokenCommandInput | ChangePasswordCommandInput | CompleteWebAuthnRegistrationCommandInput | ConfirmDeviceCommandInput | ConfirmForgotPasswordCommandInput | ConfirmSignUpCommandInput | CreateGroupCommandInput | CreateIdentityProviderCommandInput | CreateManagedLoginBrandingCommandInput | CreateResourceServerCommandInput | CreateTermsCommandInput | CreateUserImportJobCommandInput | CreateUserPoolClientCommandInput | CreateUserPoolCommandInput | CreateUserPoolDomainCommandInput | CreateUserPoolReplicaCommandInput | DeleteGroupCommandInput | DeleteIdentityProviderCommandInput | DeleteManagedLoginBrandingCommandInput | DeleteResourceServerCommandInput | DeleteTermsCommandInput | DeleteUserAttributesCommandInput | DeleteUserCommandInput | DeleteUserPoolClientCommandInput | DeleteUserPoolClientSecretCommandInput | DeleteUserPoolCommandInput | DeleteUserPoolDomainCommandInput | DeleteUserPoolReplicaCommandInput | DeleteWebAuthnCredentialCommandInput | DescribeIdentityProviderCommandInput | DescribeManagedLoginBrandingByClientCommandInput | DescribeManagedLoginBrandingCommandInput | DescribeResourceServerCommandInput | DescribeRiskConfigurationCommandInput | DescribeTermsCommandInput | DescribeUserImportJobCommandInput | DescribeUserPoolClientCommandInput | DescribeUserPoolCommandInput | DescribeUserPoolDomainCommandInput | ForgetDeviceCommandInput | ForgotPasswordCommandInput | GetCSVHeaderCommandInput | GetDeviceCommandInput | GetGroupCommandInput | GetIdentityProviderByIdentifierCommandInput | GetLogDeliveryConfigurationCommandInput | GetProvisionedLimitCommandInput | GetSigningCertificateCommandInput | GetTokensFromRefreshTokenCommandInput | GetUICustomizationCommandInput | GetUserAttributeVerificationCodeCommandInput | GetUserAuthFactorsCommandInput | GetUserCommandInput | GetUserPoolMfaConfigCommandInput | GlobalSignOutCommandInput | InitiateAuthCommandInput | ListDevicesCommandInput | ListGroupsCommandInput | ListIdentityProvidersCommandInput | ListResourceServersCommandInput | ListTagsForResourceCommandInput | ListTermsCommandInput | ListUserImportJobsCommandInput | ListUserPoolClientSecretsCommandInput | ListUserPoolClientsCommandInput | ListUserPoolReplicasCommandInput | ListUserPoolsCommandInput | ListUsersCommandInput | ListUsersInGroupCommandInput | ListWebAuthnCredentialsCommandInput | ResendConfirmationCodeCommandInput | RespondToAuthChallengeCommandInput | RevokeTokenCommandInput | SetLogDeliveryConfigurationCommandInput | SetRiskConfigurationCommandInput | SetUICustomizationCommandInput | SetUserMFAPreferenceCommandInput | SetUserPoolMfaConfigCommandInput | SetUserSettingsCommandInput | SignUpCommandInput | StartUserImportJobCommandInput | StartWebAuthnRegistrationCommandInput | StopUserImportJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAuthEventFeedbackCommandInput | UpdateDeviceStatusCommandInput | UpdateGroupCommandInput | UpdateIdentityProviderCommandInput | UpdateManagedLoginBrandingCommandInput | UpdateProvisionedLimitCommandInput | UpdateResourceServerCommandInput | UpdateTermsCommandInput | UpdateUserAttributesCommandInput | UpdateUserPoolClientCommandInput | UpdateUserPoolCommandInput | UpdateUserPoolDomainCommandInput | UpdateUserPoolReplicaCommandInput | VerifySoftwareTokenCommandInput | VerifyUserAttributeCommandInput;
|
|
147
|
+
export type ServiceInputTypes = AddCustomAttributesCommandInput | AddUserPoolClientSecretCommandInput | AdminAddUserToGroupCommandInput | AdminConfirmSignUpCommandInput | AdminCreateUserCommandInput | AdminDeleteSoftwareTokenCommandInput | AdminDeleteUserAttributesCommandInput | AdminDeleteUserCommandInput | AdminDisableProviderForUserCommandInput | AdminDisableUserCommandInput | AdminEnableUserCommandInput | AdminForgetDeviceCommandInput | AdminGetDeviceCommandInput | AdminGetUserAuthFactorsCommandInput | AdminGetUserCommandInput | AdminInitiateAuthCommandInput | AdminLinkProviderForUserCommandInput | AdminListDevicesCommandInput | AdminListGroupsForUserCommandInput | AdminListUserAuthEventsCommandInput | AdminRemoveUserFromGroupCommandInput | AdminResetUserPasswordCommandInput | AdminRespondToAuthChallengeCommandInput | AdminSetUserMFAPreferenceCommandInput | AdminSetUserPasswordCommandInput | AdminSetUserSettingsCommandInput | AdminUpdateAuthEventFeedbackCommandInput | AdminUpdateDeviceStatusCommandInput | AdminUpdateUserAttributesCommandInput | AdminUserGlobalSignOutCommandInput | AssociateSoftwareTokenCommandInput | ChangePasswordCommandInput | CompleteWebAuthnRegistrationCommandInput | ConfirmDeviceCommandInput | ConfirmForgotPasswordCommandInput | ConfirmSignUpCommandInput | CreateGroupCommandInput | CreateIdentityProviderCommandInput | CreateManagedLoginBrandingCommandInput | CreateResourceServerCommandInput | CreateTermsCommandInput | CreateUserImportJobCommandInput | CreateUserPoolClientCommandInput | CreateUserPoolCommandInput | CreateUserPoolDomainCommandInput | CreateUserPoolReplicaCommandInput | DeleteGroupCommandInput | DeleteIdentityProviderCommandInput | DeleteManagedLoginBrandingCommandInput | DeleteResourceServerCommandInput | DeleteTermsCommandInput | DeleteUserAttributesCommandInput | DeleteUserCommandInput | DeleteUserPoolClientCommandInput | DeleteUserPoolClientSecretCommandInput | DeleteUserPoolCommandInput | DeleteUserPoolDomainCommandInput | DeleteUserPoolReplicaCommandInput | DeleteWebAuthnCredentialCommandInput | DescribeIdentityProviderCommandInput | DescribeManagedLoginBrandingByClientCommandInput | DescribeManagedLoginBrandingCommandInput | DescribeResourceServerCommandInput | DescribeRiskConfigurationCommandInput | DescribeTermsByClientCommandInput | DescribeTermsCommandInput | DescribeUserImportJobCommandInput | DescribeUserPoolClientCommandInput | DescribeUserPoolCommandInput | DescribeUserPoolDomainCommandInput | ForgetDeviceCommandInput | ForgotPasswordCommandInput | GetCSVHeaderCommandInput | GetClientTokenCommandInput | GetDeviceCommandInput | GetGroupCommandInput | GetIdentityProviderByIdentifierCommandInput | GetLogDeliveryConfigurationCommandInput | GetProvisionedLimitCommandInput | GetSigningCertificateCommandInput | GetTokensFromRefreshTokenCommandInput | GetUICustomizationCommandInput | GetUserAttributeVerificationCodeCommandInput | GetUserAuthFactorsCommandInput | GetUserCommandInput | GetUserPoolMfaConfigCommandInput | GlobalSignOutCommandInput | InitiateAuthCommandInput | ListDevicesCommandInput | ListGroupsCommandInput | ListIdentityProvidersCommandInput | ListResourceServersCommandInput | ListTagsForResourceCommandInput | ListTermsCommandInput | ListUserImportJobsCommandInput | ListUserPoolClientSecretsCommandInput | ListUserPoolClientsCommandInput | ListUserPoolReplicasCommandInput | ListUserPoolsCommandInput | ListUsersCommandInput | ListUsersInGroupCommandInput | ListWebAuthnCredentialsCommandInput | ResendConfirmationCodeCommandInput | RespondToAuthChallengeCommandInput | RevokeTokenCommandInput | SetLogDeliveryConfigurationCommandInput | SetRiskConfigurationCommandInput | SetUICustomizationCommandInput | SetUserMFAPreferenceCommandInput | SetUserPoolMfaConfigCommandInput | SetUserSettingsCommandInput | SignUpCommandInput | StartUserImportJobCommandInput | StartWebAuthnRegistrationCommandInput | StopUserImportJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAuthEventFeedbackCommandInput | UpdateDeviceStatusCommandInput | UpdateGroupCommandInput | UpdateIdentityProviderCommandInput | UpdateManagedLoginBrandingCommandInput | UpdateProvisionedLimitCommandInput | UpdateResourceServerCommandInput | UpdateTermsCommandInput | UpdateUserAttributesCommandInput | UpdateUserPoolClientCommandInput | UpdateUserPoolCommandInput | UpdateUserPoolDomainCommandInput | UpdateUserPoolReplicaCommandInput | VerifySoftwareTokenCommandInput | VerifyUserAttributeCommandInput;
|
|
145
148
|
/**
|
|
146
149
|
* @public
|
|
147
150
|
*/
|
|
148
|
-
export type ServiceOutputTypes = AddCustomAttributesCommandOutput | AddUserPoolClientSecretCommandOutput | AdminAddUserToGroupCommandOutput | AdminConfirmSignUpCommandOutput | AdminCreateUserCommandOutput | AdminDeleteUserAttributesCommandOutput | AdminDeleteUserCommandOutput | AdminDisableProviderForUserCommandOutput | AdminDisableUserCommandOutput | AdminEnableUserCommandOutput | AdminForgetDeviceCommandOutput | AdminGetDeviceCommandOutput | AdminGetUserAuthFactorsCommandOutput | AdminGetUserCommandOutput | AdminInitiateAuthCommandOutput | AdminLinkProviderForUserCommandOutput | AdminListDevicesCommandOutput | AdminListGroupsForUserCommandOutput | AdminListUserAuthEventsCommandOutput | AdminRemoveUserFromGroupCommandOutput | AdminResetUserPasswordCommandOutput | AdminRespondToAuthChallengeCommandOutput | AdminSetUserMFAPreferenceCommandOutput | AdminSetUserPasswordCommandOutput | AdminSetUserSettingsCommandOutput | AdminUpdateAuthEventFeedbackCommandOutput | AdminUpdateDeviceStatusCommandOutput | AdminUpdateUserAttributesCommandOutput | AdminUserGlobalSignOutCommandOutput | AssociateSoftwareTokenCommandOutput | ChangePasswordCommandOutput | CompleteWebAuthnRegistrationCommandOutput | ConfirmDeviceCommandOutput | ConfirmForgotPasswordCommandOutput | ConfirmSignUpCommandOutput | CreateGroupCommandOutput | CreateIdentityProviderCommandOutput | CreateManagedLoginBrandingCommandOutput | CreateResourceServerCommandOutput | CreateTermsCommandOutput | CreateUserImportJobCommandOutput | CreateUserPoolClientCommandOutput | CreateUserPoolCommandOutput | CreateUserPoolDomainCommandOutput | CreateUserPoolReplicaCommandOutput | DeleteGroupCommandOutput | DeleteIdentityProviderCommandOutput | DeleteManagedLoginBrandingCommandOutput | DeleteResourceServerCommandOutput | DeleteTermsCommandOutput | DeleteUserAttributesCommandOutput | DeleteUserCommandOutput | DeleteUserPoolClientCommandOutput | DeleteUserPoolClientSecretCommandOutput | DeleteUserPoolCommandOutput | DeleteUserPoolDomainCommandOutput | DeleteUserPoolReplicaCommandOutput | DeleteWebAuthnCredentialCommandOutput | DescribeIdentityProviderCommandOutput | DescribeManagedLoginBrandingByClientCommandOutput | DescribeManagedLoginBrandingCommandOutput | DescribeResourceServerCommandOutput | DescribeRiskConfigurationCommandOutput | DescribeTermsCommandOutput | DescribeUserImportJobCommandOutput | DescribeUserPoolClientCommandOutput | DescribeUserPoolCommandOutput | DescribeUserPoolDomainCommandOutput | ForgetDeviceCommandOutput | ForgotPasswordCommandOutput | GetCSVHeaderCommandOutput | GetDeviceCommandOutput | GetGroupCommandOutput | GetIdentityProviderByIdentifierCommandOutput | GetLogDeliveryConfigurationCommandOutput | GetProvisionedLimitCommandOutput | GetSigningCertificateCommandOutput | GetTokensFromRefreshTokenCommandOutput | GetUICustomizationCommandOutput | GetUserAttributeVerificationCodeCommandOutput | GetUserAuthFactorsCommandOutput | GetUserCommandOutput | GetUserPoolMfaConfigCommandOutput | GlobalSignOutCommandOutput | InitiateAuthCommandOutput | ListDevicesCommandOutput | ListGroupsCommandOutput | ListIdentityProvidersCommandOutput | ListResourceServersCommandOutput | ListTagsForResourceCommandOutput | ListTermsCommandOutput | ListUserImportJobsCommandOutput | ListUserPoolClientSecretsCommandOutput | ListUserPoolClientsCommandOutput | ListUserPoolReplicasCommandOutput | ListUserPoolsCommandOutput | ListUsersCommandOutput | ListUsersInGroupCommandOutput | ListWebAuthnCredentialsCommandOutput | ResendConfirmationCodeCommandOutput | RespondToAuthChallengeCommandOutput | RevokeTokenCommandOutput | SetLogDeliveryConfigurationCommandOutput | SetRiskConfigurationCommandOutput | SetUICustomizationCommandOutput | SetUserMFAPreferenceCommandOutput | SetUserPoolMfaConfigCommandOutput | SetUserSettingsCommandOutput | SignUpCommandOutput | StartUserImportJobCommandOutput | StartWebAuthnRegistrationCommandOutput | StopUserImportJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAuthEventFeedbackCommandOutput | UpdateDeviceStatusCommandOutput | UpdateGroupCommandOutput | UpdateIdentityProviderCommandOutput | UpdateManagedLoginBrandingCommandOutput | UpdateProvisionedLimitCommandOutput | UpdateResourceServerCommandOutput | UpdateTermsCommandOutput | UpdateUserAttributesCommandOutput | UpdateUserPoolClientCommandOutput | UpdateUserPoolCommandOutput | UpdateUserPoolDomainCommandOutput | UpdateUserPoolReplicaCommandOutput | VerifySoftwareTokenCommandOutput | VerifyUserAttributeCommandOutput;
|
|
151
|
+
export type ServiceOutputTypes = AddCustomAttributesCommandOutput | AddUserPoolClientSecretCommandOutput | AdminAddUserToGroupCommandOutput | AdminConfirmSignUpCommandOutput | AdminCreateUserCommandOutput | AdminDeleteSoftwareTokenCommandOutput | AdminDeleteUserAttributesCommandOutput | AdminDeleteUserCommandOutput | AdminDisableProviderForUserCommandOutput | AdminDisableUserCommandOutput | AdminEnableUserCommandOutput | AdminForgetDeviceCommandOutput | AdminGetDeviceCommandOutput | AdminGetUserAuthFactorsCommandOutput | AdminGetUserCommandOutput | AdminInitiateAuthCommandOutput | AdminLinkProviderForUserCommandOutput | AdminListDevicesCommandOutput | AdminListGroupsForUserCommandOutput | AdminListUserAuthEventsCommandOutput | AdminRemoveUserFromGroupCommandOutput | AdminResetUserPasswordCommandOutput | AdminRespondToAuthChallengeCommandOutput | AdminSetUserMFAPreferenceCommandOutput | AdminSetUserPasswordCommandOutput | AdminSetUserSettingsCommandOutput | AdminUpdateAuthEventFeedbackCommandOutput | AdminUpdateDeviceStatusCommandOutput | AdminUpdateUserAttributesCommandOutput | AdminUserGlobalSignOutCommandOutput | AssociateSoftwareTokenCommandOutput | ChangePasswordCommandOutput | CompleteWebAuthnRegistrationCommandOutput | ConfirmDeviceCommandOutput | ConfirmForgotPasswordCommandOutput | ConfirmSignUpCommandOutput | CreateGroupCommandOutput | CreateIdentityProviderCommandOutput | CreateManagedLoginBrandingCommandOutput | CreateResourceServerCommandOutput | CreateTermsCommandOutput | CreateUserImportJobCommandOutput | CreateUserPoolClientCommandOutput | CreateUserPoolCommandOutput | CreateUserPoolDomainCommandOutput | CreateUserPoolReplicaCommandOutput | DeleteGroupCommandOutput | DeleteIdentityProviderCommandOutput | DeleteManagedLoginBrandingCommandOutput | DeleteResourceServerCommandOutput | DeleteTermsCommandOutput | DeleteUserAttributesCommandOutput | DeleteUserCommandOutput | DeleteUserPoolClientCommandOutput | DeleteUserPoolClientSecretCommandOutput | DeleteUserPoolCommandOutput | DeleteUserPoolDomainCommandOutput | DeleteUserPoolReplicaCommandOutput | DeleteWebAuthnCredentialCommandOutput | DescribeIdentityProviderCommandOutput | DescribeManagedLoginBrandingByClientCommandOutput | DescribeManagedLoginBrandingCommandOutput | DescribeResourceServerCommandOutput | DescribeRiskConfigurationCommandOutput | DescribeTermsByClientCommandOutput | DescribeTermsCommandOutput | DescribeUserImportJobCommandOutput | DescribeUserPoolClientCommandOutput | DescribeUserPoolCommandOutput | DescribeUserPoolDomainCommandOutput | ForgetDeviceCommandOutput | ForgotPasswordCommandOutput | GetCSVHeaderCommandOutput | GetClientTokenCommandOutput | GetDeviceCommandOutput | GetGroupCommandOutput | GetIdentityProviderByIdentifierCommandOutput | GetLogDeliveryConfigurationCommandOutput | GetProvisionedLimitCommandOutput | GetSigningCertificateCommandOutput | GetTokensFromRefreshTokenCommandOutput | GetUICustomizationCommandOutput | GetUserAttributeVerificationCodeCommandOutput | GetUserAuthFactorsCommandOutput | GetUserCommandOutput | GetUserPoolMfaConfigCommandOutput | GlobalSignOutCommandOutput | InitiateAuthCommandOutput | ListDevicesCommandOutput | ListGroupsCommandOutput | ListIdentityProvidersCommandOutput | ListResourceServersCommandOutput | ListTagsForResourceCommandOutput | ListTermsCommandOutput | ListUserImportJobsCommandOutput | ListUserPoolClientSecretsCommandOutput | ListUserPoolClientsCommandOutput | ListUserPoolReplicasCommandOutput | ListUserPoolsCommandOutput | ListUsersCommandOutput | ListUsersInGroupCommandOutput | ListWebAuthnCredentialsCommandOutput | ResendConfirmationCodeCommandOutput | RespondToAuthChallengeCommandOutput | RevokeTokenCommandOutput | SetLogDeliveryConfigurationCommandOutput | SetRiskConfigurationCommandOutput | SetUICustomizationCommandOutput | SetUserMFAPreferenceCommandOutput | SetUserPoolMfaConfigCommandOutput | SetUserSettingsCommandOutput | SignUpCommandOutput | StartUserImportJobCommandOutput | StartWebAuthnRegistrationCommandOutput | StopUserImportJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAuthEventFeedbackCommandOutput | UpdateDeviceStatusCommandOutput | UpdateGroupCommandOutput | UpdateIdentityProviderCommandOutput | UpdateManagedLoginBrandingCommandOutput | UpdateProvisionedLimitCommandOutput | UpdateResourceServerCommandOutput | UpdateTermsCommandOutput | UpdateUserAttributesCommandOutput | UpdateUserPoolClientCommandOutput | UpdateUserPoolCommandOutput | UpdateUserPoolDomainCommandOutput | UpdateUserPoolReplicaCommandOutput | VerifySoftwareTokenCommandOutput | VerifyUserAttributeCommandOutput;
|
|
149
152
|
/**
|
|
150
153
|
* @public
|
|
151
154
|
*/
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { AdminDeleteSoftwareTokenRequest, AdminDeleteSoftwareTokenResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link AdminDeleteSoftwareTokenCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface AdminDeleteSoftwareTokenCommandInput extends AdminDeleteSoftwareTokenRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link AdminDeleteSoftwareTokenCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface AdminDeleteSoftwareTokenCommandOutput extends AdminDeleteSoftwareTokenResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const AdminDeleteSoftwareTokenCommand_base: {
|
|
22
|
+
new (input: AdminDeleteSoftwareTokenCommandInput): import("@smithy/core/client").CommandImpl<AdminDeleteSoftwareTokenCommandInput, AdminDeleteSoftwareTokenCommandOutput, import("..").CognitoIdentityProviderClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: AdminDeleteSoftwareTokenCommandInput): import("@smithy/core/client").CommandImpl<AdminDeleteSoftwareTokenCommandInput, AdminDeleteSoftwareTokenCommandOutput, import("..").CognitoIdentityProviderClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Deletes a user's registered time-based one-time password (TOTP) multi-factor
|
|
28
|
+
* authentication (MFA) factor, also known as a software token. After this operation, the
|
|
29
|
+
* user can no longer sign in with TOTP MFA, and can register a new TOTP factor with
|
|
30
|
+
* <code>AssociateSoftwareToken</code>. Use this operation when a user loses access to
|
|
31
|
+
* their TOTP-generating device, for example, a lost or reset phone, and needs to register
|
|
32
|
+
* a new one.</p>
|
|
33
|
+
* <note>
|
|
34
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
35
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
36
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
37
|
+
* <p class="title">
|
|
38
|
+
* <b>Learn more</b>
|
|
39
|
+
* </p>
|
|
40
|
+
* <ul>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>
|
|
43
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
44
|
+
* </p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>
|
|
48
|
+
* <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>
|
|
49
|
+
* </p>
|
|
50
|
+
* </li>
|
|
51
|
+
* </ul>
|
|
52
|
+
* </note>
|
|
53
|
+
* @example
|
|
54
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
55
|
+
* ```javascript
|
|
56
|
+
* import { CognitoIdentityProviderClient, AdminDeleteSoftwareTokenCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
|
|
57
|
+
* // const { CognitoIdentityProviderClient, AdminDeleteSoftwareTokenCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
|
|
58
|
+
* // import type { CognitoIdentityProviderClientConfig } from "@aws-sdk/client-cognito-identity-provider";
|
|
59
|
+
* const config = {}; // type is CognitoIdentityProviderClientConfig
|
|
60
|
+
* const client = new CognitoIdentityProviderClient(config);
|
|
61
|
+
* const input = { // AdminDeleteSoftwareTokenRequest
|
|
62
|
+
* UserPoolId: "STRING_VALUE", // required
|
|
63
|
+
* Username: "STRING_VALUE", // required
|
|
64
|
+
* };
|
|
65
|
+
* const command = new AdminDeleteSoftwareTokenCommand(input);
|
|
66
|
+
* const response = await client.send(command);
|
|
67
|
+
* // {};
|
|
68
|
+
*
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @param AdminDeleteSoftwareTokenCommandInput - {@link AdminDeleteSoftwareTokenCommandInput}
|
|
72
|
+
* @returns {@link AdminDeleteSoftwareTokenCommandOutput}
|
|
73
|
+
* @see {@link AdminDeleteSoftwareTokenCommandInput} for command's `input` shape.
|
|
74
|
+
* @see {@link AdminDeleteSoftwareTokenCommandOutput} for command's `response` shape.
|
|
75
|
+
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link InternalErrorException} (server fault)
|
|
78
|
+
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
81
|
+
* <p>This exception is thrown when the Amazon Cognito service encounters an invalid
|
|
82
|
+
* parameter.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link NotAuthorizedException} (client fault)
|
|
85
|
+
* <p>This exception is thrown when a user isn't authorized.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link OperationNotEnabledException} (client fault)
|
|
88
|
+
* <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
91
|
+
* <p>This exception is thrown when the Amazon Cognito service can't find the requested
|
|
92
|
+
* resource.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
95
|
+
* <p>This exception is thrown when the user has made too many requests for a given
|
|
96
|
+
* operation.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link UserNotConfirmedException} (client fault)
|
|
99
|
+
* <p>This exception is thrown when a user isn't confirmed successfully.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link UserNotFoundException} (client fault)
|
|
102
|
+
* <p>This exception is thrown when a user isn't found.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link CognitoIdentityProviderServiceException}
|
|
105
|
+
* <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
|
|
106
|
+
*
|
|
107
|
+
*
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
export declare class AdminDeleteSoftwareTokenCommand extends AdminDeleteSoftwareTokenCommand_base {
|
|
111
|
+
/** @internal type navigation helper, not in runtime. */
|
|
112
|
+
protected static __types: {
|
|
113
|
+
api: {
|
|
114
|
+
input: AdminDeleteSoftwareTokenRequest;
|
|
115
|
+
output: {};
|
|
116
|
+
};
|
|
117
|
+
sdk: {
|
|
118
|
+
input: AdminDeleteSoftwareTokenCommandInput;
|
|
119
|
+
output: AdminDeleteSoftwareTokenCommandOutput;
|
|
120
|
+
};
|
|
121
|
+
};
|
|
122
|
+
}
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { DescribeTermsByClientRequest, DescribeTermsByClientResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link DescribeTermsByClientCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface DescribeTermsByClientCommandInput extends DescribeTermsByClientRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link DescribeTermsByClientCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface DescribeTermsByClientCommandOutput extends DescribeTermsByClientResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const DescribeTermsByClientCommand_base: {
|
|
22
|
+
new (input: DescribeTermsByClientCommandInput): import("@smithy/core/client").CommandImpl<DescribeTermsByClientCommandInput, DescribeTermsByClientCommandOutput, import("..").CognitoIdentityProviderClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: DescribeTermsByClientCommandInput): import("@smithy/core/client").CommandImpl<DescribeTermsByClientCommandInput, DescribeTermsByClientCommandOutput, import("..").CognitoIdentityProviderClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Returns details for the terms documents that are associated with an app client,
|
|
28
|
+
* identified by the app client ID, user pool ID, and terms name. For
|
|
29
|
+
* more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-terms-documents">Terms documents</a>.</p>
|
|
30
|
+
* <p>To call <code>DescribeTermsByClient</code>, you must have the
|
|
31
|
+
* <code>cognito-idp:DescribeTermsByClient</code> Identity and Access Management (IAM) permission. This
|
|
32
|
+
* operation additionally validates your permission for
|
|
33
|
+
* <code>cognito-idp:DescribeTerms</code>, the action for . As a result, an IAM policy that denies
|
|
34
|
+
* <code>cognito-idp:DescribeTerms</code> also denies requests to
|
|
35
|
+
* <code>DescribeTermsByClient</code>.</p>
|
|
36
|
+
* <note>
|
|
37
|
+
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
38
|
+
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
39
|
+
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
40
|
+
* <p class="title">
|
|
41
|
+
* <b>Learn more</b>
|
|
42
|
+
* </p>
|
|
43
|
+
* <ul>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>
|
|
46
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a>
|
|
47
|
+
* </p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>
|
|
51
|
+
* <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>
|
|
52
|
+
* </p>
|
|
53
|
+
* </li>
|
|
54
|
+
* </ul>
|
|
55
|
+
* </note>
|
|
56
|
+
* @example
|
|
57
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
58
|
+
* ```javascript
|
|
59
|
+
* import { CognitoIdentityProviderClient, DescribeTermsByClientCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
|
|
60
|
+
* // const { CognitoIdentityProviderClient, DescribeTermsByClientCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
|
|
61
|
+
* // import type { CognitoIdentityProviderClientConfig } from "@aws-sdk/client-cognito-identity-provider";
|
|
62
|
+
* const config = {}; // type is CognitoIdentityProviderClientConfig
|
|
63
|
+
* const client = new CognitoIdentityProviderClient(config);
|
|
64
|
+
* const input = { // DescribeTermsByClientRequest
|
|
65
|
+
* ClientId: "STRING_VALUE", // required
|
|
66
|
+
* UserPoolId: "STRING_VALUE", // required
|
|
67
|
+
* TermsName: "STRING_VALUE", // required
|
|
68
|
+
* };
|
|
69
|
+
* const command = new DescribeTermsByClientCommand(input);
|
|
70
|
+
* const response = await client.send(command);
|
|
71
|
+
* // { // DescribeTermsByClientResponse
|
|
72
|
+
* // Terms: { // TermsType
|
|
73
|
+
* // TermsId: "STRING_VALUE", // required
|
|
74
|
+
* // UserPoolId: "STRING_VALUE", // required
|
|
75
|
+
* // ClientId: "STRING_VALUE", // required
|
|
76
|
+
* // TermsName: "STRING_VALUE", // required
|
|
77
|
+
* // TermsSource: "LINK", // required
|
|
78
|
+
* // Enforcement: "NONE", // required
|
|
79
|
+
* // Links: { // LinksType // required
|
|
80
|
+
* // "<keys>": "STRING_VALUE",
|
|
81
|
+
* // },
|
|
82
|
+
* // CreationDate: new Date("TIMESTAMP"), // required
|
|
83
|
+
* // LastModifiedDate: new Date("TIMESTAMP"), // required
|
|
84
|
+
* // },
|
|
85
|
+
* // };
|
|
86
|
+
*
|
|
87
|
+
* ```
|
|
88
|
+
*
|
|
89
|
+
* @param DescribeTermsByClientCommandInput - {@link DescribeTermsByClientCommandInput}
|
|
90
|
+
* @returns {@link DescribeTermsByClientCommandOutput}
|
|
91
|
+
* @see {@link DescribeTermsByClientCommandInput} for command's `input` shape.
|
|
92
|
+
* @see {@link DescribeTermsByClientCommandOutput} for command's `response` shape.
|
|
93
|
+
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link InternalErrorException} (server fault)
|
|
96
|
+
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
99
|
+
* <p>This exception is thrown when the Amazon Cognito service encounters an invalid
|
|
100
|
+
* parameter.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link NotAuthorizedException} (client fault)
|
|
103
|
+
* <p>This exception is thrown when a user isn't authorized.</p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link OperationNotEnabledException} (client fault)
|
|
106
|
+
* <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
109
|
+
* <p>This exception is thrown when the Amazon Cognito service can't find the requested
|
|
110
|
+
* resource.</p>
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
113
|
+
* <p>This exception is thrown when the user has made too many requests for a given
|
|
114
|
+
* operation.</p>
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link CognitoIdentityProviderServiceException}
|
|
117
|
+
* <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
|
|
118
|
+
*
|
|
119
|
+
*
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
export declare class DescribeTermsByClientCommand extends DescribeTermsByClientCommand_base {
|
|
123
|
+
/** @internal type navigation helper, not in runtime. */
|
|
124
|
+
protected static __types: {
|
|
125
|
+
api: {
|
|
126
|
+
input: DescribeTermsByClientRequest;
|
|
127
|
+
output: DescribeTermsByClientResponse;
|
|
128
|
+
};
|
|
129
|
+
sdk: {
|
|
130
|
+
input: DescribeTermsByClientCommandInput;
|
|
131
|
+
output: DescribeTermsByClientCommandOutput;
|
|
132
|
+
};
|
|
133
|
+
};
|
|
134
|
+
}
|
|
@@ -27,6 +27,12 @@ declare const DescribeUserPoolDomainCommand_base: {
|
|
|
27
27
|
* <p>Given a user pool domain name, returns information about the domain
|
|
28
28
|
* configuration.</p>
|
|
29
29
|
* <note>
|
|
30
|
+
* <p>This operation doesn't return results when you query a prefix domain in a
|
|
31
|
+
* secondary Region. Prefix domains are Region-specific and can only be described in
|
|
32
|
+
* the Region where they were created. To describe a prefix domain for a replica user
|
|
33
|
+
* pool, make the request to the primary Region's endpoint.</p>
|
|
34
|
+
* </note>
|
|
35
|
+
* <note>
|
|
30
36
|
* <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
31
37
|
* this operation, you must use IAM credentials to authorize requests, and you must
|
|
32
38
|
* grant yourself the corresponding IAM permission in a policy.</p>
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { GetClientTokenRequest, GetClientTokenResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link GetClientTokenCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface GetClientTokenCommandInput extends GetClientTokenRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link GetClientTokenCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface GetClientTokenCommandOutput extends GetClientTokenResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const GetClientTokenCommand_base: {
|
|
22
|
+
new (input: GetClientTokenCommandInput): import("@smithy/core/client").CommandImpl<GetClientTokenCommandInput, GetClientTokenCommandOutput, import("..").CognitoIdentityProviderClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: GetClientTokenCommandInput): import("@smithy/core/client").CommandImpl<GetClientTokenCommandInput, GetClientTokenCommandOutput, import("..").CognitoIdentityProviderClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Issues an access token for machine-to-machine (M2M) authorization. Your app client
|
|
28
|
+
* provides its client ID and secret, and receives an access token that authorizes requests
|
|
29
|
+
* to your resource servers. <code>GetClientToken</code> provides the same functionality as
|
|
30
|
+
* the OAuth2 client-credentials grant; both authorize an application rather than a user.</p>
|
|
31
|
+
* <p>To use this operation, you must configure the app client with a client secret and
|
|
32
|
+
* enable the <code>ALLOW_CLIENT_TOKEN_AUTH</code> authentication flow. The
|
|
33
|
+
* <code>ALLOW_CLIENT_TOKEN_AUTH</code> flow is mutually exclusive with user authentication
|
|
34
|
+
* flows. It must be the only authentication flow that you configure for the app client. For
|
|
35
|
+
* more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html">Scopes, M2M, and resource servers</a>.</p>
|
|
36
|
+
* <note>
|
|
37
|
+
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
|
|
38
|
+
* this operation, you can't use IAM credentials to authorize requests, and you can't
|
|
39
|
+
* grant IAM permissions in policies. For more information about authorization models in
|
|
40
|
+
* Amazon Cognito, see <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>.</p>
|
|
41
|
+
* </note>
|
|
42
|
+
* @example
|
|
43
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
44
|
+
* ```javascript
|
|
45
|
+
* import { CognitoIdentityProviderClient, GetClientTokenCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
|
|
46
|
+
* // const { CognitoIdentityProviderClient, GetClientTokenCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
|
|
47
|
+
* // import type { CognitoIdentityProviderClientConfig } from "@aws-sdk/client-cognito-identity-provider";
|
|
48
|
+
* const config = {}; // type is CognitoIdentityProviderClientConfig
|
|
49
|
+
* const client = new CognitoIdentityProviderClient(config);
|
|
50
|
+
* const input = { // GetClientTokenRequest
|
|
51
|
+
* ClientId: "STRING_VALUE", // required
|
|
52
|
+
* Secret: "STRING_VALUE", // required
|
|
53
|
+
* Scopes: [ // ScopeListType
|
|
54
|
+
* "STRING_VALUE",
|
|
55
|
+
* ],
|
|
56
|
+
* ClientMetadata: { // ClientMetadataType
|
|
57
|
+
* "<keys>": "STRING_VALUE",
|
|
58
|
+
* },
|
|
59
|
+
* };
|
|
60
|
+
* const command = new GetClientTokenCommand(input);
|
|
61
|
+
* const response = await client.send(command);
|
|
62
|
+
* // { // GetClientTokenResponse
|
|
63
|
+
* // ClientAuthenticationResult: { // ClientAuthenticationResultType
|
|
64
|
+
* // AccessToken: "STRING_VALUE",
|
|
65
|
+
* // ExpiresIn: Number("int"),
|
|
66
|
+
* // TokenType: "STRING_VALUE",
|
|
67
|
+
* // },
|
|
68
|
+
* // };
|
|
69
|
+
*
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @param GetClientTokenCommandInput - {@link GetClientTokenCommandInput}
|
|
73
|
+
* @returns {@link GetClientTokenCommandOutput}
|
|
74
|
+
* @see {@link GetClientTokenCommandInput} for command's `input` shape.
|
|
75
|
+
* @see {@link GetClientTokenCommandOutput} for command's `response` shape.
|
|
76
|
+
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
79
|
+
* <p>This exception is thrown when WAF doesn't allow your request based on a web
|
|
80
|
+
* ACL that's associated with your user pool.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link InternalErrorException} (server fault)
|
|
83
|
+
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
86
|
+
* <p>This exception is thrown when the Amazon Cognito service encounters an invalid
|
|
87
|
+
* parameter.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link NotAuthorizedException} (client fault)
|
|
90
|
+
* <p>This exception is thrown when a user isn't authorized.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link OperationNotEnabledException} (client fault)
|
|
93
|
+
* <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
96
|
+
* <p>This exception is thrown when the Amazon Cognito service can't find the requested
|
|
97
|
+
* resource.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
100
|
+
* <p>This exception is thrown when the user has made too many requests for a given
|
|
101
|
+
* operation.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link CognitoIdentityProviderServiceException}
|
|
104
|
+
* <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
|
|
105
|
+
*
|
|
106
|
+
*
|
|
107
|
+
* @example Example – Get an access token for machine-to-machine authorization
|
|
108
|
+
* ```javascript
|
|
109
|
+
* // The following example gets an access token for the app client 1example23456789 with the custom scope solar-system-data/asteroids.add.
|
|
110
|
+
* const input = {
|
|
111
|
+
* ClientId: "1example23456789",
|
|
112
|
+
* Scopes: [
|
|
113
|
+
* "solar-system-data/asteroids.add"
|
|
114
|
+
* ],
|
|
115
|
+
* Secret: "exampleClientSecret123EXAMPLE"
|
|
116
|
+
* };
|
|
117
|
+
* const command = new GetClientTokenCommand(input);
|
|
118
|
+
* const response = await client.send(command);
|
|
119
|
+
* /* response is
|
|
120
|
+
* {
|
|
121
|
+
* ClientAuthenticationResult: {
|
|
122
|
+
* AccessToken: "eyJra456defEXAMPLE",
|
|
123
|
+
* ExpiresIn: 3600,
|
|
124
|
+
* TokenType: "Bearer"
|
|
125
|
+
* }
|
|
126
|
+
* }
|
|
127
|
+
* *\/
|
|
128
|
+
* ```
|
|
129
|
+
*
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
export declare class GetClientTokenCommand extends GetClientTokenCommand_base {
|
|
133
|
+
/** @internal type navigation helper, not in runtime. */
|
|
134
|
+
protected static __types: {
|
|
135
|
+
api: {
|
|
136
|
+
input: GetClientTokenRequest;
|
|
137
|
+
output: GetClientTokenResponse;
|
|
138
|
+
};
|
|
139
|
+
sdk: {
|
|
140
|
+
input: GetClientTokenCommandInput;
|
|
141
|
+
output: GetClientTokenCommandOutput;
|
|
142
|
+
};
|
|
143
|
+
};
|
|
144
|
+
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { SetUserPoolMfaConfigRequest
|
|
2
|
+
import type { SetUserPoolMfaConfigRequest } from "../models/models_0";
|
|
3
|
+
import type { SetUserPoolMfaConfigResponse } from "../models/models_1";
|
|
3
4
|
/**
|
|
4
5
|
* @public
|
|
5
6
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { SetUserSettingsRequest, SetUserSettingsResponse } from "../models/
|
|
2
|
+
import type { SetUserSettingsRequest, SetUserSettingsResponse } from "../models/models_1";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { StartUserImportJobRequest, StartUserImportJobResponse } from "../models/
|
|
2
|
+
import type { StartUserImportJobRequest, StartUserImportJobResponse } from "../models/models_1";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
@@ -3,6 +3,7 @@ export * from "./AddUserPoolClientSecretCommand";
|
|
|
3
3
|
export * from "./AdminAddUserToGroupCommand";
|
|
4
4
|
export * from "./AdminConfirmSignUpCommand";
|
|
5
5
|
export * from "./AdminCreateUserCommand";
|
|
6
|
+
export * from "./AdminDeleteSoftwareTokenCommand";
|
|
6
7
|
export * from "./AdminDeleteUserAttributesCommand";
|
|
7
8
|
export * from "./AdminDeleteUserCommand";
|
|
8
9
|
export * from "./AdminDisableProviderForUserCommand";
|
|
@@ -61,6 +62,7 @@ export * from "./DescribeManagedLoginBrandingByClientCommand";
|
|
|
61
62
|
export * from "./DescribeManagedLoginBrandingCommand";
|
|
62
63
|
export * from "./DescribeResourceServerCommand";
|
|
63
64
|
export * from "./DescribeRiskConfigurationCommand";
|
|
65
|
+
export * from "./DescribeTermsByClientCommand";
|
|
64
66
|
export * from "./DescribeTermsCommand";
|
|
65
67
|
export * from "./DescribeUserImportJobCommand";
|
|
66
68
|
export * from "./DescribeUserPoolClientCommand";
|
|
@@ -69,6 +71,7 @@ export * from "./DescribeUserPoolDomainCommand";
|
|
|
69
71
|
export * from "./ForgetDeviceCommand";
|
|
70
72
|
export * from "./ForgotPasswordCommand";
|
|
71
73
|
export * from "./GetCSVHeaderCommand";
|
|
74
|
+
export * from "./GetClientTokenCommand";
|
|
72
75
|
export * from "./GetDeviceCommand";
|
|
73
76
|
export * from "./GetGroupCommand";
|
|
74
77
|
export * from "./GetIdentityProviderByIdentifierCommand";
|
|
@@ -283,6 +283,18 @@ export declare class UsernameExistsException extends __BaseException {
|
|
|
283
283
|
*/
|
|
284
284
|
constructor(opts: __ExceptionOptionType<UsernameExistsException, __BaseException>);
|
|
285
285
|
}
|
|
286
|
+
/**
|
|
287
|
+
* <p>This exception is thrown when a user isn't confirmed successfully.</p>
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
export declare class UserNotConfirmedException extends __BaseException {
|
|
291
|
+
readonly name: "UserNotConfirmedException";
|
|
292
|
+
readonly $fault: "client";
|
|
293
|
+
/**
|
|
294
|
+
* @internal
|
|
295
|
+
*/
|
|
296
|
+
constructor(opts: __ExceptionOptionType<UserNotConfirmedException, __BaseException>);
|
|
297
|
+
}
|
|
286
298
|
/**
|
|
287
299
|
* <p>This exception is thrown when a user tries to confirm the account with an email
|
|
288
300
|
* address or phone number that has already been supplied as an alias for a different user
|
|
@@ -362,18 +374,6 @@ export declare class UnsupportedOperationException extends __BaseException {
|
|
|
362
374
|
*/
|
|
363
375
|
constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
|
|
364
376
|
}
|
|
365
|
-
/**
|
|
366
|
-
* <p>This exception is thrown when a user isn't confirmed successfully.</p>
|
|
367
|
-
* @public
|
|
368
|
-
*/
|
|
369
|
-
export declare class UserNotConfirmedException extends __BaseException {
|
|
370
|
-
readonly name: "UserNotConfirmedException";
|
|
371
|
-
readonly $fault: "client";
|
|
372
|
-
/**
|
|
373
|
-
* @internal
|
|
374
|
-
*/
|
|
375
|
-
constructor(opts: __ExceptionOptionType<UserNotConfirmedException, __BaseException>);
|
|
376
|
-
}
|
|
377
377
|
/**
|
|
378
378
|
* <p>This exception is thrown when user pool add-ons aren't enabled.</p>
|
|
379
379
|
* @public
|