AWS Account

2021/09/30 - AWS Account - 3 new api methods

Changes  This release of the Account Management API enables customers to manage the alternate contacts for their AWS accounts. For more information, see https://docs.aws.amazon.com/accounts/latest/reference/accounts-welcome.html

DeleteAlternateContact (new) Link ¶

Deletes the specified alternate contact from an Amazon Web Services account.

For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.

See also: AWS API Documentation

Request Syntax

client.delete_alternate_contact(
    AccountId='string',
    AlternateContactType='BILLING'|'OPERATIONS'|'SECURITY'
)
type AccountId

string

param AccountId

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 admin 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.

type AlternateContactType

string

param AlternateContactType

[REQUIRED]

Specifies which of the alternate contacts to delete.

returns

None

PutAlternateContact (new) Link ¶

Modifies the specified alternate contact attached to an Amazon Web Services account.

For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.

See also: AWS API Documentation

Request Syntax

client.put_alternate_contact(
    AccountId='string',
    AlternateContactType='BILLING'|'OPERATIONS'|'SECURITY',
    EmailAddress='string',
    Name='string',
    PhoneNumber='string',
    Title='string'
)
type AccountId

string

param AccountId

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 admin 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.

type AlternateContactType

string

param AlternateContactType

[REQUIRED]

Specifies which alternate contact you want to create or update.

type EmailAddress

string

param EmailAddress

[REQUIRED]

Specifies an email address for the alternate contact.

type Name

string

param Name

[REQUIRED]

Specifies a name for the alternate contact.

type PhoneNumber

string

param PhoneNumber

[REQUIRED]

Specifies a phone number for the alternate contact.

type Title

string

param Title

[REQUIRED]

Specifies a title for the alternate contact.

returns

None

GetAlternateContact (new) Link ¶

Retrieves the specified alternate contact attached to an Amazon Web Services account.

For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.

See also: AWS API Documentation

Request Syntax

client.get_alternate_contact(
    AccountId='string',
    AlternateContactType='BILLING'|'OPERATIONS'|'SECURITY'
)
type AccountId

string

param AccountId

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 admin 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.

type AlternateContactType

string

param AlternateContactType

[REQUIRED]

Specifies which alternate contact you want to retrieve.

rtype

dict

returns

Response Syntax

{
    'AlternateContact': {
        'AlternateContactType': 'BILLING'|'OPERATIONS'|'SECURITY',
        'EmailAddress': 'string',
        'Name': 'string',
        'PhoneNumber': 'string',
        'Title': 'string'
    }
}

Response Structure

  • (dict) --

    • AlternateContact (dict) --

      A structure that contains the details for the specified alternate contact.

      • AlternateContactType (string) --

        The type of alternate contact.

      • EmailAddress (string) --

        The email address associated with this alternate contact.

      • Name (string) --

        The name associated with this alternate contact.

      • PhoneNumber (string) --

        The phone number associated with this alternate contact.

      • Title (string) --

        The title associated with this alternate contact.