Account / Client / verify_phone_number

verify_phone_number

Account.Client.verify_phone_number(**kwargs)

Verifies the phone number in the primary contact information of an Amazon Web Services account by submitting the one-time passcode that SendPhoneNumberVerification sent to that phone number.

For complete details about how to use the primary contact operations, see Update the primary contact for your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.verify_phone_number(
    AccountId='string',
    Otp='string'
)
Parameters:

  • AccountId (string) –

    Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.

    If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.

    To use this parameter, the caller must be an identity in the organization’s management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated administrator account assigned.

    Note

    The management account can’t specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.

    To call this operation on an account that is not a member of an organization, then don’t specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

  • Otp (string) –

    [REQUIRED]

    The one-time passcode sent to the phone number in the primary contact information by the SendPhoneNumberVerification operation.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'PENDING'|'VERIFIED'|'UNVERIFIED'|'NOT_SUPPORTED'
}

Response Structure

  • (dict) –

    • Status (string) –

      The verification status of the phone number in the primary contact information after the submitted one-time passcode is evaluated. Valid values:

      • PENDING – A one-time passcode has been sent and is waiting to be submitted.

      • VERIFIED – The phone number has been verified.

      • UNVERIFIED – The phone number has not been verified.

      • NOT_SUPPORTED – Phone number verification isn’t available for this account.

Exceptions

  • Account.Client.exceptions.ResourceNotFoundException

  • Account.Client.exceptions.AccessDeniedException

  • Account.Client.exceptions.ValidationException

  • Account.Client.exceptions.ConflictException

  • Account.Client.exceptions.TooManyRequestsException

  • Account.Client.exceptions.InternalServerException