Amazon Web Services, Inc.

AWS Account

Operations for Amazon Web Services Account Management

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Operations for Amazon Web Services Account Management

Endpoints 18

Primary email

  • POSTAccept primary email update/acceptPrimaryEmailUpdateAccepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the…
  • POSTGet primary email/getPrimaryEmailRetrieves the primary email address for the specified account.
  • POSTGet primary email update status/getPrimaryEmailUpdateStatusRetrieves the status of the most recent primary email update for the specified account. For complete details about how to update the primary email address,…
  • POSTStart primary email update/startPrimaryEmailUpdateStarts the process to update the primary email address for the specified account.

Alternate contact

  • POSTDelete alternate contact/deleteAlternateContactDeletes the specified alternate contact from an Amazon Web Services account. For complete details about how to use the alternate contact operations, see…
  • POSTGet alternate contact/getAlternateContactRetrieves the specified alternate contact attached to an Amazon Web Services account. For complete details about how to use the alternate contact operations,…
  • POSTPut alternate contact/putAlternateContactModifies the specified alternate contact attached to an Amazon Web Services account. For complete details about how to use the alternate contact operations,…

Region opt

  • POSTDisable region/disableRegionDisables (opts-out) a particular Region for an account. The act of disabling a Region will remove all IAM access to any resources that reside in that Region.
  • POSTEnable region/enableRegionEnables (opts-in) a particular Region for an account.
  • POSTGet region opt status/getRegionOptStatusRetrieves the opt-in status of a particular Region.
  • POSTList regions/listRegionsLists all the Regions for a given account and their respective opt-in statuses. Optionally, this list can be filtered by the region-opt-status-contains…

Account name

  • POSTGet account information/getAccountInformationRetrieves information about the specified account including its account name, account ID, account creation date and time, and account state. To use this API,…
  • POSTPut account name/putAccountNameUpdates the account name of the specified account. To use this API, IAM principals must have the account:PutAccountName IAM permission.

Contact information

  • POSTGet contact information/getContactInformationRetrieves the primary contact information of an Amazon Web Services account. For complete details about how to use the primary contact operations, see Update…
  • POSTPut contact information/putContactInformationUpdates the primary contact information of an Amazon Web Services account. For complete details about how to use the primary contact operations, see Update…

Commercial to gov cloud gateway

  • POSTGet gov cloud account information/getGovCloudAccountInformationRetrieves information about the GovCloud account linked to the specified standard account (if it exists) including the GovCloud account ID and state. To use…

Phone number verification

  • POSTSend phone number verification/sendPhoneNumberVerificationSends a one-time passcode to the phone number in the primary contact information of an Amazon Web Services account. Use VerifyPhoneNumber to submit the…
  • POSTVerify phone number/verifyPhoneNumberVerifies the phone number in the primary contact information of an Amazon Web Services account by submitting the one-time passcode that…

API details

Base URL
https://account.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
18 operations on 18 pathsPOST 18
Main resources
Primary email 4Region opt 4Alternate contact 3Account name 2Contact information 2Phone number verification 2Commercial to gov cloud gateway 1
Description format
AWS Smithy model, API version 2021-02-01

How to test the AWS Account in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Account collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Accept primary email update” (POST /acceptPrimaryEmailUpdate), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Account?

Operations for Amazon Web Services Account Management It is listed under Developer tools and has 18 endpoints.

Who publishes the AWS Account?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Account?

Requests go to https://account.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Account?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Account have?

18 operations on 18 paths (18 POST). The largest groups are Primary email, Region opt, Alternate contact, Account name.

Is forking the AWS Account free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.