@aws-sdk/client-cognito-identity-provider
Version:
AWS SDK for JavaScript Cognito Identity Provider Client for Node.js, Browser and React Native
170 lines (169 loc) • 9.52 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient";
import { GetUserAttributeVerificationCodeRequest, GetUserAttributeVerificationCodeResponse } from "../models/models_0";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link GetUserAttributeVerificationCodeCommand}.
*/
export interface GetUserAttributeVerificationCodeCommandInput extends GetUserAttributeVerificationCodeRequest {
}
/**
* @public
*
* The output of {@link GetUserAttributeVerificationCodeCommand}.
*/
export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAttributeVerificationCodeResponse, __MetadataBearer {
}
declare const GetUserAttributeVerificationCodeCommand_base: {
new (input: GetUserAttributeVerificationCodeCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserAttributeVerificationCodeCommandInput, GetUserAttributeVerificationCodeCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (input: GetUserAttributeVerificationCodeCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserAttributeVerificationCodeCommandInput, GetUserAttributeVerificationCodeCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>Given an attribute name, sends a user attribute verification code for the specified
* attribute name to the currently signed-in user.</p>
* <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p>
* <note>
* <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For
* this operation, you can't use IAM credentials to authorize requests, and you can't
* grant IAM permissions in policies. For more information about authorization models in
* 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>
* </note>
* <note>
* <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
* require you to register an origination phone number before you can send SMS messages
* to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a
* phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>.
* Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
* receive SMS messages might not be able to sign up, activate their accounts, or sign
* in.</p>
* <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,
* Amazon Simple Notification Service might place your account in the SMS sandbox. In <i>
* <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
* mode</a>
* </i>, you can send messages only to verified phone
* numbers. After you test your app while in the sandbox environment, you can move out
* 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
* Developer Guide</i>.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { CognitoIdentityProviderClient, GetUserAttributeVerificationCodeCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
* // const { CognitoIdentityProviderClient, GetUserAttributeVerificationCodeCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
* const client = new CognitoIdentityProviderClient(config);
* const input = { // GetUserAttributeVerificationCodeRequest
* AccessToken: "STRING_VALUE", // required
* AttributeName: "STRING_VALUE", // required
* ClientMetadata: { // ClientMetadataType
* "<keys>": "STRING_VALUE",
* },
* };
* const command = new GetUserAttributeVerificationCodeCommand(input);
* const response = await client.send(command);
* // { // GetUserAttributeVerificationCodeResponse
* // CodeDeliveryDetails: { // CodeDeliveryDetailsType
* // Destination: "STRING_VALUE",
* // DeliveryMedium: "SMS" || "EMAIL",
* // AttributeName: "STRING_VALUE",
* // },
* // };
*
* ```
*
* @param GetUserAttributeVerificationCodeCommandInput - {@link GetUserAttributeVerificationCodeCommandInput}
* @returns {@link GetUserAttributeVerificationCodeCommandOutput}
* @see {@link GetUserAttributeVerificationCodeCommandInput} for command's `input` shape.
* @see {@link GetUserAttributeVerificationCodeCommandOutput} for command's `response` shape.
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
*
* @throws {@link CodeDeliveryFailureException} (client fault)
* <p>This exception is thrown when a verification code fails to deliver
* successfully.</p>
*
* @throws {@link ForbiddenException} (client fault)
* <p>This exception is thrown when WAF doesn't allow your request based on a web
* ACL that's associated with your user pool.</p>
*
* @throws {@link InternalErrorException} (server fault)
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
*
* @throws {@link InvalidEmailRoleAccessPolicyException} (client fault)
* <p>This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP
* status code: 400.</p>
*
* @throws {@link InvalidLambdaResponseException} (client fault)
* <p>This exception is thrown when Amazon Cognito encounters an invalid Lambda response.</p>
*
* @throws {@link InvalidParameterException} (client fault)
* <p>This exception is thrown when the Amazon Cognito service encounters an invalid
* parameter.</p>
*
* @throws {@link InvalidSmsRoleAccessPolicyException} (client fault)
* <p>This exception is returned when the role provided for SMS configuration doesn't have
* permission to publish using Amazon SNS.</p>
*
* @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault)
* <p>This exception is thrown when the trust relationship is not valid for the role
* provided for SMS configuration. This can happen if you don't trust
* <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does
* not match what is provided in the SMS configuration for the user pool.</p>
*
* @throws {@link LimitExceededException} (client fault)
* <p>This exception is thrown when a user exceeds the limit for a requested Amazon Web Services
* resource.</p>
*
* @throws {@link NotAuthorizedException} (client fault)
* <p>This exception is thrown when a user isn't authorized.</p>
*
* @throws {@link PasswordResetRequiredException} (client fault)
* <p>This exception is thrown when a password reset is required.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>This exception is thrown when the Amazon Cognito service can't find the requested
* resource.</p>
*
* @throws {@link TooManyRequestsException} (client fault)
* <p>This exception is thrown when the user has made too many requests for a given
* operation.</p>
*
* @throws {@link UnexpectedLambdaException} (client fault)
* <p>This exception is thrown when Amazon Cognito encounters an unexpected exception with
* Lambda.</p>
*
* @throws {@link UserLambdaValidationException} (client fault)
* <p>This exception is thrown when the Amazon Cognito service encounters a user validation exception
* with the Lambda service.</p>
*
* @throws {@link UserNotConfirmedException} (client fault)
* <p>This exception is thrown when a user isn't confirmed successfully.</p>
*
* @throws {@link UserNotFoundException} (client fault)
* <p>This exception is thrown when a user isn't found.</p>
*
* @throws {@link CognitoIdentityProviderServiceException}
* <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
*
*
* @public
*/
export declare class GetUserAttributeVerificationCodeCommand extends GetUserAttributeVerificationCodeCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: GetUserAttributeVerificationCodeRequest;
output: GetUserAttributeVerificationCodeResponse;
};
sdk: {
input: GetUserAttributeVerificationCodeCommandInput;
output: GetUserAttributeVerificationCodeCommandOutput;
};
};
}