AWS Account

2024/06/06 - AWS Account - 3 new api methods

Changes  This release adds 3 new APIs (AcceptPrimaryEmailUpdate, GetPrimaryEmail, and StartPrimaryEmailUpdate) used to centrally manage the root user email address of member accounts within an AWS organization.

GetPrimaryEmail (new) Link ¶

Retrieves the primary email address for the specified account.

See also: AWS API Documentation

Request Syntax

client.get_primary_email(
    AccountId='string'
)
type AccountId:

string

param AccountId:

[REQUIRED]

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. 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 admin account assigned.

This operation can only be called from the management account or the delegated administrator account of an organization for a member account.

rtype:

dict

returns:

Response Syntax

{
    'PrimaryEmail': 'string'
}

Response Structure

  • (dict) --

    • PrimaryEmail (string) --

      Retrieves the primary email address associated with the specified account.

StartPrimaryEmailUpdate (new) Link ¶

Starts the process to update the primary email address for the specified account.

See also: AWS API Documentation

Request Syntax

client.start_primary_email_update(
    AccountId='string',
    PrimaryEmail='string'
)
type AccountId:

string

param AccountId:

[REQUIRED]

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. 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 admin account assigned.

This operation can only be called from the management account or the delegated administrator account of an organization for a member account.

type PrimaryEmail:

string

param PrimaryEmail:

[REQUIRED]

The new primary email address (also known as the root user email address) to use in the specified account.

rtype:

dict

returns:

Response Syntax

{
    'Status': 'PENDING'|'ACCEPTED'
}

Response Structure

  • (dict) --

    • Status (string) --

      The status of the primary email update request.

AcceptPrimaryEmailUpdate (new) Link ¶

Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.

See also: AWS API Documentation

Request Syntax

client.accept_primary_email_update(
    AccountId='string',
    Otp='string',
    PrimaryEmail='string'
)
type AccountId:

string

param AccountId:

[REQUIRED]

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. 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 admin account assigned.

This operation can only be called from the management account or the delegated administrator account of an organization for a member account.

type Otp:

string

param Otp:

[REQUIRED]

The OTP code sent to the PrimaryEmail specified on the StartPrimaryEmailUpdate API call.

type PrimaryEmail:

string

param PrimaryEmail:

[REQUIRED]

The new primary email address for use with the specified account. This must match the PrimaryEmail from the StartPrimaryEmailUpdate API call.

rtype:

dict

returns:

Response Syntax

{
    'Status': 'PENDING'|'ACCEPTED'
}

Response Structure

  • (dict) --

    • Status (string) --

      Retrieves the status of the accepted primary email update request.